setsumei 0.0.10 → 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ed66d6642b9aa0f6e115bae45ee429c0112e70f
+  data.tar.gz: d927bc2bb3d1df4a38fed82b9c65d60a18d6fdd7
+SHA512:
+  metadata.gz: 17f822edef6b4b2a23a57d6b74b5ed3834d0085842231998df12e8fce800ca0569f247ad307ce230b1c2bfc8e44e3db7f95f26cabc70e5a766748181187319e6
+  data.tar.gz: 1db588dd87cd2362cc1742c1fd7c8b6fccf32f1abd60028754c672bf8c3f4886e5b73875047e943c30aa46b2e29ebe4a671bb995bc92aafea058865e7397b24a

data.tar.gz.sig

@@ -0,0 +1 @@
+�e(՝I�C)�X���I�<�]}�d�-!Ar�\��Mk�=(�{�f^��4F[�:d���ez�����r�
�#Z��������&@n�1�I���V_�����&�k?尓�(ݿ��1�ϫՊt����˩k���ߵ�N�AXc��i���������Y����q<v�s@������ �m�r6
��b9zt�_8;���t��蕝�7�����G�*��mPs}2ô7

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/README.md

@@ -1,4 +1,5 @@
 Setsumei
 --------
+[![Build Status](https://secure.travis-ci.org/JonRowe/setsumei.png)](http://travis-ci.org/JonRowe/setsumei) [![Code Climate](https://codeclimate.com/github/JonRowe/setsumei.png)](https://codeclimate.com/github/JonRowe/setsumei)
 
 Api description tool to build ruby DSL's from JSON data.

data/Rakefile

@@ -1,2 +1,9 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new :spec
+task :default => [:spec]

data/lib/setsumei/describable.rb

@@ -1,10 +1,10 @@
+require 'setsumei/describable/attribute'
 require 'setsumei/describable/boolean_attribute'
 require 'setsumei/describable/string_attribute'
 require 'setsumei/describable/float_attribute'
 require 'setsumei/describable/int_attribute'
 require 'setsumei/describable/object_attribute'
-require 'setsumei/describable/time_attribute'
-require 'setsumei/describable/date_attribute'
+require 'setsumei/describable/date_time_attribute'
 require 'setsumei/describable/collection'
 
 module Setsumei
@@ -21,7 +21,7 @@ module Setsumei
       end
 
       def define field_name, options = {}
-        _defined_attributes[field_name] = attribute_type(options[:as_a]).named field_name, options
+        _defined_attributes[field_name] = Attribute.new field_name, attribute_type(options), options
         attr_accessor field_name
       end
 
@@ -66,21 +66,20 @@ module Setsumei
         def _defined_attributes
           (@_defined_attributes ||= {})
         end
-        def attribute_type(type)
-          case type
-            when :boolean   then BooleanAttribute
-            when :string    then StringAttribute
-            when nil        then StringAttribute
-            when :float     then FloatAttribute
-            when :int       then IntAttribute
-            when :date      then DateAttribute
-            when :time      then TimeAttribute
-          else
-            object_attribute_if_a_class(type) or raise(ArgumentError)
-          end
-        end
-        def object_attribute_if_a_class(type)
-          (type.is_a?(Class) && ObjectAttribute)
+
+        def attribute_type(options = {})
+            case options.fetch(:as_a,:string)
+              when :boolean   then BooleanAttribute.new
+              when :string    then StringAttribute.new
+              when nil        then StringAttribute.new
+              when :float     then FloatAttribute.new
+              when :int       then IntAttribute.new
+              when :date      then DateTimeAttribute.new(:date, options[:format], Date)
+              when :time      then DateTimeAttribute.new(:time, options[:format], Time)
+              when Class      then ObjectAttribute.new(options[:as_a])
+            else
+              raise ArgumentError
+            end
         end
     end
   end

data/lib/setsumei/describable/attribute.rb

@@ -0,0 +1,43 @@
+module Setsumei
+  module Describable
+    class Attribute
+
+      def initialize name, type, options = {}
+        self.name = name
+        self.type = type
+        self.lookup_key = options.delete(:from_within)
+        self.options = options.tap { |o| o.delete :as_a }
+      end
+
+      attr_accessor :name, :options, :lookup_key, :type, :klass
+
+      def is_an_attribute_of_type?(other)
+        type == other
+      end
+      alias :is_a?    :is_an_attribute_of_type?
+      alias :kind_of? :is_an_attribute_of_type?
+
+      def value_for(pre_type_cast_value)
+        type.cast pre_type_cast_value
+      end
+
+      def set_value_on(object, options)
+        object.send accessor, value_from_hash(options[:from_value_in])
+      end
+
+      private
+        def accessor
+          :"#{name}="
+        end
+
+        def value_from_hash(hash)
+          value_for hash[ key_for(hash)]
+        end
+
+        def key_for(hash)
+          lookup_key || Build::Key.for(name, given: hash.keys)
+        end
+
+    end
+  end
+end

data/lib/setsumei/describable/boolean_attribute.rb

@@ -2,39 +2,14 @@ module Setsumei
   module Describable
     class BooleanAttribute
 
-      def BooleanAttribute.named(name, options = {})
-        options = options.dup
-        new.tap do |attribute|
-          attribute.name = name
-          attribute.lookup_key = options.delete(:from_within)
-          attribute.options = options.tap { |o| o.delete :as_a }
-        end
+      def == other
+        :boolean == other || BooleanAttribute == other
       end
 
-      attr_accessor :name, :options, :lookup_key
-
-      def is_an_attribute_of_type?(type)
-        type == :boolean || type == self.class
-      end
-
-      def value_for(pre_type_cast_value)
-        pre_type_cast_value.to_s.downcase == "true" || pre_type_cast_value.to_s == "1"
-      end
-
-      def set_value_on(object, options)
-        object.send accessor, value_from_hash(options[:from_value_in])
+      def cast value
+        value.to_s.downcase == "true" || value.to_s == "1"
       end
 
-      private
-        def accessor
-          :"#{name}="
-        end
-        def value_from_hash(hash)
-          value_for hash[ key_for(hash)]
-        end
-        def key_for(hash)
-          lookup_key || Build::Key.for(name, given: hash.keys)
-        end
     end
   end
 end

data/lib/setsumei/describable/date_time_attribute.rb

@@ -0,0 +1,21 @@
+module Setsumei
+  module Describable
+    class DateTimeAttribute
+
+      def initialize type, format, parser
+        @type, @parser = type, parser
+        @format = format || '%Y-%m-%d %H:%M'
+      end
+      attr_reader :format, :type, :parser
+
+      def == other
+        type == other || self.class == other
+      end
+
+      def cast value
+        parser.strptime value, format
+      end
+
+    end
+  end
+end

data/lib/setsumei/describable/float_attribute.rb

@@ -2,39 +2,14 @@ module Setsumei
   module Describable
     class FloatAttribute
 
-      def FloatAttribute.named(name, options = {})
-        options = options.dup
-        new.tap do |attribute|
-          attribute.name = name
-          attribute.lookup_key = options.delete(:from_within)
-          attribute.options = options.tap { |o| o.delete :as_a }
-        end
+      def == other
+        :float == other || FloatAttribute == other
       end
 
-      attr_accessor :name, :options, :lookup_key
-
-      def is_an_attribute_of_type?(type)
-        type == :float || type == self.class
-      end
-
-      def value_for(pre_type_cast_value)
-        pre_type_cast_value.to_f
-      end
-
-      def set_value_on(object, options)
-        object.send accessor, value_from_hash(options[:from_value_in])
+      def cast value
+        value.to_f
       end
 
-      private
-        def accessor
-          :"#{name}="
-        end
-        def value_from_hash(hash)
-          value_for hash[ key_for(hash)]
-        end
-        def key_for(hash)
-          lookup_key || Build::Key.for(name, given: hash.keys)
-        end
     end
   end
 end

data/lib/setsumei/describable/int_attribute.rb

@@ -1,39 +1,15 @@
 module Setsumei
   module Describable
     class IntAttribute
-      def IntAttribute.named(name, options = {})
-        options = options.dup
-        new.tap do |attribute|
-          attribute.name = name
-          attribute.lookup_key = options.delete(:from_within)
-          attribute.options = options.tap { |o| o.delete :as_a }
-        end
-      end
-
-      attr_accessor :name, :options, :lookup_key
-
-      def is_an_attribute_of_type?(type)
-        type == :int || type == self.class
-      end
 
-      def value_for(pre_type_cast_value)
-        pre_type_cast_value.to_f.round
+      def == other
+        :int == other || IntAttribute == other
       end
 
-      def set_value_on(object, options)
-        object.send accessor, value_from_hash(options[:from_value_in])
+      def cast value
+        value.to_f.round
       end
 
-      private
-        def accessor
-          :"#{name}="
-        end
-        def value_from_hash(hash)
-          value_for hash[ key_for(hash)]
-        end
-        def key_for(hash)
-          lookup_key || Build::Key.for(name, given: hash.keys)
-        end
     end
   end
 end

data/lib/setsumei/describable/object_attribute.rb

@@ -1,52 +1,26 @@
 module Setsumei
   module Describable
-    class ObjectAttribute
+    class ObjectAttribute < Attribute
 
-      def ObjectAttribute.named(name,options = {})
-        options = options.dup
-        raise ArgumentError.new("you must specify what the object is") unless options.has_key? :as_a
-        new.tap do |attribute|
-          attribute.name = name
-          attribute.klass = options.delete(:as_a)
-          attribute.lookup_key = options.delete(:from_within)
-          attribute.options = options
-        end
+      def initialize type = nil
+        @klass = type || Object
       end
+      attr_reader :klass
 
-      attr_accessor :name, :klass, :options, :lookup_key
-
-      def initialize
-        self.klass = Object
+      def == other
+        :object == other || ObjectAttribute == other || klass == other
       end
 
-      def value_for(data)
+      def cast data
         return nil if data.nil? || data.empty?
 
         begin
-          self.klass.create_from data
+          klass.create_from data
         rescue NoMethodError
-          Build.a self.klass, from: data
+          Build.a klass, from: data
         end
       end
 
-      def is_an_attribute_of_type?(type)
-        type == :object || type == self.class || type == self.klass
-      end
-
-      def set_value_on(object, options)
-        object.send accessor, value_from_hash(options[:from_value_in])
-      end
-
-      private
-        def accessor
-          :"#{name}="
-        end
-        def value_from_hash(hash)
-          value_for hash[ key_for(hash)]
-        end
-        def key_for(hash)
-          lookup_key || Build::Key.for(name, given: hash.keys)
-        end
     end
   end
 end

data/lib/setsumei/describable/string_attribute.rb

@@ -1,39 +1,15 @@
 module Setsumei
   module Describable
     class StringAttribute
-      def StringAttribute.named(name,options = {})
-        options = options.dup
-        new.tap do |attribute|
-          attribute.name = name
-          attribute.lookup_key = options.delete(:from_within)
-          attribute.options = options.tap { |o| o.delete :as_a }
-        end
-      end
-
-      attr_accessor :name, :options, :lookup_key
-
-      def is_an_attribute_of_type?(type)
-        type == :string || type == self.class
-      end
 
-      def value_for(pre_type_cast_value)
-        pre_type_cast_value.to_s
+      def == other
+        :string == other || StringAttribute == other
       end
 
-      def set_value_on(object, options)
-        object.send accessor, value_from_hash(options[:from_value_in])
+      def cast value
+        value.to_s
       end
 
-      private
-        def accessor
-          :"#{name}="
-        end
-        def value_from_hash(hash)
-          value_for hash[ key_for(hash)]
-        end
-        def key_for(hash)
-          lookup_key || Build::Key.for(name, given: hash.keys)
-        end
     end
   end
 end

data/lib/setsumei/version.rb

@@ -1,3 +1,3 @@
 module Setsumei
-  VERSION = "0.0.10"
+  VERSION = "0.0.12"
 end

data/setsumei.gemspec

@@ -17,8 +17,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency     'json'
+
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'autotest-standalone'
-  s.add_development_dependency 'ruby-debug19'
 end

data/spec/setsumei/describable/attribute_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+module Setsumei
+  module Describable
+    describe Attribute do
+
+      let(:attribute) { Attribute.new :name, type }
+
+      describe '#initialize name, type' do
+        let(:type) { double }
+        subject { attribute }
+
+        its(:name) { should == :name }
+        its(:type) { should == type }
+      end
+
+      describe "#value_for(value)" do
+        let(:type)  { double "type", cast: cast }
+        let(:value) { double "value" }
+        let(:cast)  { double "cast" }
+
+        it 'will cast value to type' do
+          type.should_receive(:cast).with(value)
+          attribute.value_for value
+        end
+        it 'will return the cast value' do
+          attribute.value_for(value).should == cast
+        end
+      end
+
+      %w[is_an_attribute_of_type? is_a? kind_of?].each do |meth|
+        describe "##{meth}" do
+          let(:type)   { double "type", :== => result }
+          let(:other)  { double "value" }
+          let(:result) { double "result" }
+
+          it 'compares using type' do
+            type.should_receive(:==).with(other)
+            attribute.send meth, other
+          end
+          it 'returns the value' do
+            attribute.send(meth, other).should eq result
+          end
+        end
+      end
+
+      describe "set_value_on object, from_value_in: hash" do
+        let(:hash) { Hash.new }
+        let(:key) { "key" }
+        let(:hash_keys) { mock "hash_keys" }
+        let(:value_in_hash) { mock "value_in_hash" }
+
+        let(:object) { mock "object", :name= => nil }
+
+        let(:converted_value) { mock "converted_value" }
+        let(:type) { double "type", cast: converted_value }
+
+        before do
+          Build::Key.stub(:for).and_return(key)
+          hash[key] = value_in_hash
+        end
+
+        subject { attribute.set_value_on object, from_value_in: hash }
+
+        it "should detect the key it should use to retrieve the value from the hash" do
+          hash.should_receive(:keys).and_return(hash_keys)
+          Build::Key.should_receive(:for).with(:name, given: hash_keys ).and_return(key)
+          subject
+        end
+        it "should convert the value" do
+          attribute.should_receive(:value_for).with(value_in_hash).and_return(converted_value)
+          subject
+        end
+        it "should pass object a value to the attribute described by this class" do
+          object.should_receive(:name=).with(converted_value)
+          subject
+        end
+
+        context "where a specific key has been specified" do
+          before do
+            hash["MySpecialKey"] = hash.delete key
+            attribute.lookup_key = "MySpecialKey"
+          end
+
+          it "should use this key for the hash lookup instead" do
+            Setsumei::Build::Key.should_not_receive(:for)
+            type.should_receive(:cast).with(value_in_hash).and_return(converted_value)
+            subject
+          end
+        end
+      end
+    end
+  end
+end