mugatu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b41d7bdc2af41ccf1b7b86e6e55009bd5a1ef422
+  data.tar.gz: ca50175753086c35746a671e9e53adffadbc563e
+SHA512:
+  metadata.gz: 40230ee76ee06abf95ddd0f29582ccb7c709202403cd252b81c088ff8371e119506d7e5e0a298fde237304847ad4fd8e2819f6d3189f5222d1d57c316a6dad7f
+  data.tar.gz: d59de7ee301107e172adfd32a6c2dcd5392b4c70454ddace9fb4995a0bc76b6ebc7771cd970228d6b23791c01a11c81b30898bd7513422c32d32eba4f392c500

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Steven Weiss
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# Mugatu
+
+Mugatu is small library for creating domain models.

data/Rakefile

@@ -0,0 +1,5 @@
+task :spec do
+  Dir.glob('./spec/**/*_spec.rb').each { |file| require file }
+end
+
+task :default => :spec

data/lib/mugatu.rb

@@ -0,0 +1,4 @@
+require_relative './mugatu/version'
+require_relative './mugatu/entity'
+require_relative './mugatu/attribute'
+require_relative './mugatu/attribute_type'

data/lib/mugatu/attribute.rb

@@ -0,0 +1,25 @@
+module Mugatu
+  class Attribute
+    attr_reader :key, :type, :value
+
+    def initialize(key, type, options = {})
+      @key       = key
+      @type      = type
+      self.value = options[:default_value] # nil when none is set.
+    end
+
+    def value=(new_value)
+      @value = cast(new_value)
+    end
+
+    private
+
+    def cast(value)
+      if value.is_a?(type) || value.nil?
+        value
+      else
+        type.cast(value)
+      end
+    end
+  end
+end

data/lib/mugatu/attribute_type.rb

@@ -0,0 +1,25 @@
+module Mugatu
+  module AttributeType
+    def set_cast_with(sym)
+      @cast_with = sym
+    end
+
+    def get_cast_with
+      @cast_with
+    end
+
+    def cast(value)
+      if value.respond_to?(get_cast_with)
+        value.send(get_cast_with)
+      else
+        raise_cast_error(value)
+      end
+    end
+
+    def raise_cast_error(value)
+      raise TypeError, "cannot cast #{value} into #{name} (TypeError)"
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + '/types/**/*.rb'].each {|file| require file }

data/lib/mugatu/entity.rb

@@ -0,0 +1,40 @@
+module Mugatu
+  class Entity
+    def self.attribute(key, type, options = {})
+      attribute = Attribute.new(key, type, options)
+
+      define_attribute_reader(attribute)
+      define_attribute_writer(attribute)
+
+      attributes << attribute
+    end
+
+    def self.attributes
+      @attributes ||= []
+    end
+
+    def initialize(attributes = {})
+      self.attributes.each do |a|
+        send("#{a.key}=", attributes[a.key]) if attributes.key?(a.key)
+      end
+    end
+
+    def attributes
+      self.class.attributes
+    end
+
+    private
+
+    def self.define_attribute_reader(attribute)
+      define_method attribute.key do
+        attribute.value
+      end
+    end
+
+    def self.define_attribute_writer(attribute)
+      define_method "#{attribute.key}=" do |value|
+        attribute.value = value
+      end
+    end
+  end
+end

data/lib/mugatu/types/array.rb

@@ -0,0 +1,5 @@
+class Array
+  extend Mugatu::AttributeType
+
+  set_cast_with :to_a
+end

data/lib/mugatu/types/boolean.rb

@@ -0,0 +1,5 @@
+class Boolean
+  extend Mugatu::AttributeType
+
+  set_cast_with :to_b
+end

data/lib/mugatu/types/boolean/false.rb

@@ -0,0 +1,5 @@
+class FalseClass
+  def to_b
+    self
+  end
+end

data/lib/mugatu/types/boolean/true.rb

@@ -0,0 +1,5 @@
+class TrueClass
+  def to_b
+    self
+  end
+end

data/lib/mugatu/types/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  extend Mugatu::AttributeType
+
+  set_cast_with :to_h
+end

data/lib/mugatu/types/nil.rb

@@ -0,0 +1,5 @@
+class NilClass
+  def to_b
+    false
+  end
+end

data/lib/mugatu/types/numeric.rb

@@ -0,0 +1,5 @@
+class Numeric
+  def to_b
+    !zero?
+  end
+end

data/lib/mugatu/types/numeric/float.rb

@@ -0,0 +1,5 @@
+class Float
+  extend Mugatu::AttributeType
+
+  set_cast_with :to_f
+end

data/lib/mugatu/types/numeric/integer.rb

@@ -0,0 +1,5 @@
+class Integer
+  extend Mugatu::AttributeType
+
+  set_cast_with :to_i
+end

data/lib/mugatu/types/string.rb

@@ -0,0 +1,17 @@
+class String
+  extend Mugatu::AttributeType
+
+  TRUTHY = ['t', 'true', 'on', 'y', 'yes', '1'].freeze
+  FALSY  = ['f', 'false', 'off', 'n', 'no', '0'].freeze
+
+  set_cast_with :to_s
+
+  def to_b
+    value = downcase
+
+    return true  if TRUTHY.include?(value)
+    return false if FALSY.include?(value)
+
+    self.class.raise_cast_error(self)
+  end
+end

data/lib/mugatu/version.rb

@@ -0,0 +1,3 @@
+module Mugatu
+  VERSION = '0.1.0'.freeze
+end

data/mugatu.gemspec

@@ -0,0 +1,12 @@
+require_relative './lib/mugatu/version'
+
+Gem::Specification.new do |s|
+  s.name = 'mugatu'
+  s.summary = 'Mugatu'
+  s.version = Mugatu::VERSION
+  s.authors = ['Steve Weiss']
+  s.email = ['weissst@mail.gvsu.edu']
+  s.homepage = 'https://github.com/sirscriptalot/mugatu'
+  s.license = 'MIT'
+  s.files = `git ls-files`.split("\n")
+end

data/spec/mugatu_spec.rb

@@ -0,0 +1,71 @@
+require_relative './spec_helper'
+
+class Entity < Mugatu::Entity
+  attribute :foo, String, default_value: 'bar'
+end
+
+describe 'Mugatu::Entity' do
+  before do
+    @entity = Entity.new
+  end
+
+  describe '#self.attributes' do
+    context 'no attributes set' do
+      it 'initializes as an empty array' do
+        assert Mugatu::Entity.attributes.empty?
+      end
+    end
+
+    context 'attributes set' do
+      it 'returns the @attributes array' do
+        refute Entity.attributes.empty?
+      end
+    end
+  end
+
+  describe '#self.attribute' do
+    it 'defines a reader method for attribute.key' do
+      assert @entity.respond_to?(:foo)
+    end
+
+    it 'defines a writer method for attribute.key' do
+      assert @entity.respond_to?(:foo=)
+    end
+  end
+
+  describe '#initialize' do
+    it 'sets default values' do
+      assert @entity.foo = 'bar'
+    end
+  end
+
+  describe '#attributes' do
+    it 'returns the class\' @attributes' do
+      assert @entity.attributes == @entity.class.attributes
+    end
+  end
+end
+
+describe 'Mugatu::Attribute' do
+  before do
+    @key           = :foo
+    @default_value = 'bar'
+    @attribute     = Mugatu::Attribute.new(@key, String, default_value: @default_value)
+  end
+
+  describe '#initialize' do
+    describe 'options[:default_value]' do
+      it 'sets initial @value' do
+        assert @attribute.value == @default_value
+      end
+    end
+  end
+
+  describe '#value=' do
+    it 'allows nil values' do
+      @attribute.value = nil
+
+      assert @attribute.value.nil?
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require          'minitest/autorun'
+require_relative '../lib/mugatu'
+
+def context(*args, &block)
+  describe(*args, &block)
+end

data/spec/types/array_spec.rb

@@ -0,0 +1,18 @@
+describe 'Array' do
+  describe '#self.cast' do
+    it 'casts value to Array' do
+      assert Array.cast([])          == []
+      assert Array.cast({foo: :bar}) == [[:foo, :bar]]
+    end
+  end
+
+  context 'to_a is not implemented' do
+    it 'raises a TypeError' do
+      assert_raises(TypeError) { assert Array.cast('array') }
+      assert_raises(TypeError) { assert Array.cast(1) }
+      assert_raises(TypeError) { assert Array.cast(1.0) }
+      assert_raises(TypeError) { assert Array.cast(true) }
+      assert_raises(TypeError) { assert Array.cast(false) }
+    end
+  end
+end

data/spec/types/boolean/false_spec.rb

@@ -0,0 +1,7 @@
+describe 'FalseClass' do
+  describe '#to_b' do
+    it 'returns false' do
+      refute false.to_b
+    end
+  end
+end

data/spec/types/boolean/true_spec.rb

@@ -0,0 +1,7 @@
+describe 'TrueClass' do
+  describe '#to_b' do
+    it 'returns true' do
+      assert true.to_b
+    end
+  end
+end

data/spec/types/boolean_spec.rb

@@ -0,0 +1,18 @@
+describe 'Boolean' do
+  describe '#self.cast' do
+    it 'casts value to a Boolean' do
+      assert Hash.cast([[:foo, :bar]]) == {foo: :bar}
+      assert Hash.cast({foo: :bar})    == {foo: :bar}
+    end
+  end
+
+  context 'to_h is not implemented' do
+    it 'raises a TypeError' do
+      assert_raises(TypeError) { assert Hash.cast('hash') }
+      assert_raises(TypeError) { assert Hash.cast(1) }
+      assert_raises(TypeError) { assert Hash.cast(1.0) }
+      assert_raises(TypeError) { assert Hash.cast(true) }
+      assert_raises(TypeError) { assert Hash.cast(false) }
+    end
+  end
+end

data/spec/types/hash_spec.rb

@@ -0,0 +1,18 @@
+describe 'Hash' do
+  describe '#self.cast' do
+    it 'casts value to Array' do
+      assert Hash.cast([[:foo, :bar]]) == {foo: :bar}
+      assert Hash.cast({foo: :bar})    == {foo: :bar}
+    end
+  end
+
+  context 'to_h is not implemented' do
+    it 'raises a TypeError' do
+      assert_raises(TypeError) { assert Hash.cast('hash') }
+      assert_raises(TypeError) { assert Hash.cast(1) }
+      assert_raises(TypeError) { assert Hash.cast(1.0) }
+      assert_raises(TypeError) { assert Hash.cast(true) }
+      assert_raises(TypeError) { assert Hash.cast(false) }
+    end
+  end
+end

data/spec/types/nil_spec.rb

@@ -0,0 +1,7 @@
+describe 'NilClass' do
+  describe '#to_b' do
+    it 'returns false' do
+      refute nil.to_b
+    end
+  end
+end

data/spec/types/numeric/float_spec.rb

@@ -0,0 +1,28 @@
+describe 'Float' do
+  describe '#self.cast' do
+    it 'casts value to Float' do
+      assert Float.cast('one') == 0.0
+      assert Float.cast('1')   == 1.0
+      assert Float.cast(1)     == 1.0
+      assert Float.cast(1.0)   == 1.0
+      assert Float.cast(nil)   == 0.0
+    end
+
+    context 'to_f is not implemented' do
+      it 'raises a TypeError' do
+        assert_raises(TypeError) { assert Float.cast([]) }
+        assert_raises(TypeError) { assert Float.cast({}) }
+        assert_raises(TypeError) { assert Float.cast(true) }
+        assert_raises(TypeError) { assert Float.cast(false) }
+      end
+    end
+  end
+
+  describe '#to_b' do
+    it 'casts value to Boolean' do
+      refute 0.0.to_b
+      assert 0.1.to_b
+      assert 1.1.to_b
+    end
+  end
+end

data/spec/types/numeric/integer_spec.rb

@@ -0,0 +1,28 @@
+describe 'Integer' do
+  describe '#self.cast' do
+    it 'casts value to Integer' do
+      assert Integer.cast('one') == 0
+      assert Integer.cast('1')   == 1
+      assert Integer.cast(1)     == 1
+      assert Integer.cast(1.0)   == 1
+      assert Integer.cast(nil)   == 0
+    end
+
+    context 'to_i is not implemented' do
+      it 'raises a TypeError' do
+        assert_raises(TypeError) { assert Integer.cast([]) }
+        assert_raises(TypeError) { assert Integer.cast({}) }
+        assert_raises(TypeError) { assert Integer.cast(true) }
+        assert_raises(TypeError) { assert Integer.cast(false) }
+      end
+    end
+  end
+
+  describe '#to_b' do
+    it 'casts value to Boolean' do
+      refute 0.to_b
+      assert 1.to_b
+      assert 2.to_b
+    end
+  end
+end

data/spec/types/string_spec.rb

@@ -0,0 +1,40 @@
+describe 'String' do
+  describe '#self.cast' do
+    it 'casts value to String' do
+      assert String.cast('one') == 'one'
+      assert String.cast(1)     == '1'
+      assert String.cast(1.0)   == '1.0'
+      assert String.cast([])    == '[]'
+      assert String.cast({})    == '{}'
+      assert String.cast(true)  == 'true'
+      assert String.cast(false) == 'false'
+      assert String.cast(nil)   == ''
+    end
+  end
+
+  describe '#to_b' do
+    context 'value is truthy' do
+      it 'returns true' do
+        ['t', 'T', 'true', 'TRUE', 'on', 'ON', 'y', 'Y', 'yes', 'YES', '1'].each do |value|
+          assert value.to_b
+        end
+      end
+    end
+
+    context 'value is falsy' do
+      it 'returns false' do
+        ['f', 'F', 'false', 'FALSE', 'off', 'OFF', 'n', 'N', 'no', 'NO', '0'].each do |value|
+          refute value.to_b
+        end
+      end
+    end
+
+    context 'value is not a truthy or falsy' do
+      it 'raises TypeError' do
+        assert_raises TypeError do
+          'foo'.to_b
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: mugatu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Weiss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-16 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- weissst@mail.gvsu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mugatu.rb
+- lib/mugatu/attribute.rb
+- lib/mugatu/attribute_type.rb
+- lib/mugatu/entity.rb
+- lib/mugatu/types/array.rb
+- lib/mugatu/types/boolean.rb
+- lib/mugatu/types/boolean/false.rb
+- lib/mugatu/types/boolean/true.rb
+- lib/mugatu/types/hash.rb
+- lib/mugatu/types/nil.rb
+- lib/mugatu/types/numeric.rb
+- lib/mugatu/types/numeric/float.rb
+- lib/mugatu/types/numeric/integer.rb
+- lib/mugatu/types/string.rb
+- lib/mugatu/version.rb
+- mugatu.gemspec
+- spec/mugatu_spec.rb
+- spec/spec_helper.rb
+- spec/types/array_spec.rb
+- spec/types/boolean/false_spec.rb
+- spec/types/boolean/true_spec.rb
+- spec/types/boolean_spec.rb
+- spec/types/hash_spec.rb
+- spec/types/nil_spec.rb
+- spec/types/numeric/float_spec.rb
+- spec/types/numeric/integer_spec.rb
+- spec/types/string_spec.rb
+homepage: https://github.com/sirscriptalot/mugatu
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Mugatu
+test_files: []