setsumei 0.0.1

data/spec/setsumei/describable/string_attribute_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+module Setsumei
+  module Describable
+    describe StringAttribute do
+      its(:name) { should == nil }
+
+      describe ".named(name)" do
+        let(:name) { :my_string_field }
+
+        subject { StringAttribute.named(name) }
+
+        it { should be_a StringAttribute }
+        its(:name) { should == name }
+      end
+
+      describe "#value_for(pre_type_cast_value)" do
+        let(:string_attribute) { StringAttribute.new }
+
+        subject { string_attribute.value_for pre_type_cast_value }
+
+        context "where the value is a string" do
+          let(:pre_type_cast_value) { "I'm already a string" }
+
+          it { should == pre_type_cast_value }
+        end
+
+        context "where the value isn't a string" do
+          let(:to_s_value) { "stringified value of thing thats a string" }
+          let(:pre_type_cast_value) { mock "something thats not a string", to_s: to_s_value }
+
+          it { should == to_s_value }
+        end
+      end
+
+      describe "#is_an_attribute_of_type?" do
+        let(:string_attribute) { StringAttribute.new }
+
+        subject { string_attribute.is_an_attribute_of_type? type }
+
+        context "where type is :string" do
+          let(:type) { :string }
+          it { should be_true }
+        end
+
+        context "where type is StringAttribute" do
+          let(:type) { StringAttribute }
+          it { should be_true }
+        end
+
+        context "where type is unknown" do
+          let(:type) { mock "an unknown type" }
+          it { should be_false }
+        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(:converted_value) { mock "converted_value" }
+
+        let(:object) { mock "object", :my_string_attribute= => nil }
+
+        let(:string_attribute) { StringAttribute.named :my_string_attribute }
+
+        before do
+          Build::Key.stub(:for).and_return(key)
+          hash[key] = value_in_hash
+          string_attribute.stub(:value_for).and_return(converted_value)
+        end
+
+        subject { string_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(:my_string_attribute, given: hash_keys ).and_return(key)
+          subject
+        end
+        it "should convert the value" do
+          string_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(:my_string_attribute=).with(converted_value)
+          subject
+        end
+      end
+    end
+  end
+end

data/spec/setsumei/describable_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+module Setsumei
+  describe Describable do
+    let(:klass) { Class.new }
+
+    before do
+      klass.class_eval do
+        include Setsumei::Describable
+      end
+    end
+
+    describe ".defined_attributes" do
+      it "should have a list of defined attributes" do
+        klass.should respond_to :defined_attributes
+        klass.defined_attributes.should be_a Hash
+      end
+      it "should have a definition method" do
+        klass.should respond_to :define
+      end
+      it "should return defined attributes as a duplicated hash" do
+        klass.define :field
+        klass.defined_attributes[:field].should_not be_nil
+        klass.defined_attributes.delete(:field)
+        klass.defined_attributes[:field].should_not be_nil
+      end
+    end
+
+    describe ".define" do
+      it "should allow defining of attributes" do
+        klass.define :field
+        klass.defined_attributes[:field].should_not be_nil
+      end
+      it "should create string attributes by default" do
+        klass.define :field
+        klass.defined_attributes[:field].should be_a Describable::StringAttribute
+      end
+      it "should have set the name on the attribute to be the field name" do
+        klass.define :field
+        klass.defined_attributes[:field].name.should == :field
+      end
+
+      context "where setting a specific type" do
+        subject { klass }
+
+        it_should_behave_like "it creates an attribute of type", :boolean, creating_a: Describable::BooleanAttribute
+        it_should_behave_like "it creates an attribute of type", :string,  creating_a: Describable::StringAttribute
+        it_should_behave_like "it creates an attribute of type", :float,   creating_a: Describable::FloatAttribute
+        it_should_behave_like "it creates an attribute of type", :int,     creating_a: Describable::IntAttribute
+
+        it_should_behave_like "it creates an attribute of type", Class.new, creating_a: Describable::ObjectAttribute
+      end
+    end
+
+    describe "instances with defined attributes" do
+      before do
+        klass.class_eval do
+          define :my_string_attribute
+        end
+      end
+
+      it "should allow me set to and retrieve values for my attribute" do
+        klass.new.tap do |object|
+          object.my_string_attribute = "Hey Everybody!"
+          object.my_string_attribute.should == "Hey Everybody!"
+        end
+      end
+    end
+
+    describe ".collection_of(klass,options)" do
+      let(:another_klass) { Class.new }
+      let(:options) { mock "options" }
+      let(:element) { mock "element" }
+      let(:element_2) { mock "element_2" }
+      let(:instance) { klass.new }
+      let(:collection) { mock "collection" }
+
+      before do
+        Describable::Collection.stub(:of).and_return(collection)
+      end
+
+      subject { klass.collection_of another_klass, options }
+
+      context "a klass with collection_of invoked" do
+        context "should behave like an array" do
+          before do
+            subject
+            instance << element
+          end
+
+          it "should accept elements with shovel" do
+            true
+          end
+          it "should be testable with include" do
+            instance.should include element
+          end
+          it "should be accessible with []" do
+            instance[0].should == element
+          end
+          it "should settable with []=" do
+            instance[0] = element_2
+            instance[0].should == element_2
+          end
+          it "should be accessible with first" do
+            instance.first.should == element
+          end
+          it "should be iterable over" do
+            values = []
+            instance.each { |value| values << value }
+            values.should == [element]
+          end
+          it "should be injectable" do
+            instance.inject({}) { |b,c| b[b.size.to_s] = c; b }.should == { "0" => element }
+          end
+          it "should be mappable" do
+            instance << element_2
+            instance.map { |a| [a] }.should == [[element],[element_2]]
+          end
+          it "should be comparable to an array" do
+            instance.should == [element]
+          end
+        end
+      end
+
+      it "should setup a describable collection" do
+        Describable::Collection.should_receive(:of).with(another_klass,options).and_return(collection)
+        subject
+        klass.defined_attributes.values.should include collection
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'ruby-debug'
+require 'setsumei'
+
+Dir[File.join(File.dirname(__FILE__),"support/**/*.rb")].each { |f| require f }

data/spec/support/be_an_attribute_of_type_matcher.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :be_an_attribute_of_type do |type|
+  match do |subject|
+    subject.is_an_attribute_of_type? type
+  end
+end

data/spec/support/shared_examples/attribute_type_creation.rb

@@ -0,0 +1,13 @@
+shared_examples "it creates an attribute of type" do |_type,options|
+  _klass = options[:creating_a]
+  context "definition of #{_type} attributes" do
+    it "should allow defining #{_type} attributes" do
+      subject.define :field, as_a: _type
+      subject.defined_attributes[:field].should be_a _klass
+    end
+    it "should have defined an attribute testable as :#{_type}" do
+      subject.define :field, as_a: _type
+      subject.defined_attributes[:field].should be_an_attribute_of_type(_type)
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: setsumei
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jon Rowe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: autotest-standalone
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: A tool for describing API's as ruby objects. Currently supports building these objects from JSON
+email: 
+- hello@jonrowe.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/setsumei.rb
+- lib/setsumei/build.rb
+- lib/setsumei/build/key.rb
+- lib/setsumei/describable.rb
+- lib/setsumei/describable/boolean_attribute.rb
+- lib/setsumei/describable/collection.rb
+- lib/setsumei/describable/float_attribute.rb
+- lib/setsumei/describable/int_attribute.rb
+- lib/setsumei/describable/object_attribute.rb
+- lib/setsumei/describable/string_attribute.rb
+- lib/setsumei/version.rb
+- setsumei.gemspec
+- spec/setsumei/build/key_spec.rb
+- spec/setsumei/build_spec.rb
+- spec/setsumei/describable/boolean_attribute_spec.rb
+- spec/setsumei/describable/collection_spec.rb
+- spec/setsumei/describable/float_attribute_spec.rb
+- spec/setsumei/describable/int_attribute_spec.rb
+- spec/setsumei/describable/object_attribute_spec.rb
+- spec/setsumei/describable/string_attribute_spec.rb
+- spec/setsumei/describable_spec.rb
+- spec/spec_helper.rb
+- spec/support/be_an_attribute_of_type_matcher.rb
+- spec/support/shared_examples/attribute_type_creation.rb
+has_rdoc: true
+homepage: https://github.com/JonRowe/setsumei
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A tool for describing API's as ruby objects
+test_files: 
+- spec/setsumei/build/key_spec.rb
+- spec/setsumei/build_spec.rb
+- spec/setsumei/describable/boolean_attribute_spec.rb
+- spec/setsumei/describable/collection_spec.rb
+- spec/setsumei/describable/float_attribute_spec.rb
+- spec/setsumei/describable/int_attribute_spec.rb
+- spec/setsumei/describable/object_attribute_spec.rb
+- spec/setsumei/describable/string_attribute_spec.rb
+- spec/setsumei/describable_spec.rb
+- spec/spec_helper.rb
+- spec/support/be_an_attribute_of_type_matcher.rb
+- spec/support/shared_examples/attribute_type_creation.rb