transcriber 0.0.1 → 0.0.2

data/spec/unit/resource/response/property_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Resource::Response::Property do
+  class Customer
+    attr_accessor :login
+  end
+
+  subject {Resource::Property.new(:login)}
+
+  it "returns a pair with property name and value" do
+    customer = Customer.new.tap {|c| c.login = "jackiechan2010"}
+    subject.to_resource(customer).should == {login: "jackiechan2010"}
+  end
+
+  context "when this key shouldn't be present on resource" do
+    it "returns an empty hash" do
+      subject.should_receive(:present?).and_return false
+      customer = Customer.new.tap {|c| c.login = "jackiechan2010"}
+      subject.to_resource(customer).should == {}
+    end
+  end
+end

data/spec/unit/resource/response/relation_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe Resource::Response do
+  shared_examples_for "a relation" do
+    context "#to_relation" do
+      it "returns a pair with property name and value" do
+        subject.to_relation(example).should == result
+      end
+    end
+
+    context "#to_resource" do
+      context "when the key shouldn't be present on resource" do
+        it "returns an empty hash" do
+          subject.should_receive(:present?).and_return false
+          subject.to_resource(example).should == {}
+        end
+      end
+
+      context "when the relation instance variable in parent returns nil" do
+        it "returns an empty hash" do
+          subject.to_resource(example).should == {}
+        end
+      end
+
+      context "otherwise" do
+
+      end
+    end
+  end
+
+  context "when has one" do
+    before do
+      class ExampleChild < Resource
+        id
+        belongs_to :example
+      end
+
+      class Example < Resource
+        id
+        has_one  :example_child
+      end
+    end
+
+    subject {Example.keys[1]}
+
+    let(:example) {Example.new(id: 100)}
+    let(:result)  {{rel: :example_child, href: "/examples/100/example_child"}}
+
+    it_behaves_like "a relation"
+  end
+
+  context "when has many" do
+    before do
+      class ExampleChild < Resource
+        property   :id
+        belongs_to :example
+      end
+
+      class Example < Resource
+        property :id
+        has_many :example_children
+      end
+    end
+
+    subject {Example.keys[1]}
+
+    let(:example) {Example.new(id: 200)}
+    let(:result)  {{rel: :example_children, href: "/examples/200/example_children"}}
+
+    it_behaves_like "a relation"
+  end
+
+  context "when belongs to one" do
+    before do
+      class ExampleChild < Resource
+        property   :id
+        belongs_to :example
+      end
+
+      class Example < Resource
+        property :id
+        has_many :example_children
+      end
+    end
+
+    subject {ExampleChild.keys[1]}
+
+    let(:example) {ExampleChild.new(id: 200)}
+    let(:result)  {{rel: :example, href: "/examples/200/example_children"}}
+
+    it_behaves_like "a relation"
+  end
+
+  context "when using forbidden key names" do
+    [:resource_id, :resource].each do |forbidden_name|
+      it "raises an exception for #{forbidden_name}" do
+        expect {
+          class Example < Resource
+            property forbidden_name
+          end
+        }.to raise_error
+      end
+    end
+  end
+end

data/spec/unit/resource/serialization/boolean_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Resource::Serialization::Boolean do
+  [true,  "true",  "TRUE",  "1", 1, 1.0, "x", "X", "t", "T"].each do |true_value|
+    context "when value is #{true_value}" do
+      it "returns true" do
+        subject.class.serialize(true_value).should be_true
+      end
+    end
+  end
+
+  [false, "false", "FALSE", "0", 0, 0.0,  "", " ", "f", "F", nil].each do |false_value|
+    context "when value is #{false_value}" do
+      it "returns false" do
+        subject.class.serialize(false_value).should be_false
+      end
+    end
+  end
+
+  context "when an invalid value is serialized" do
+    it "raises an error" do
+      expect {subject.class.serialize("neither true or false")}.to raise_error
+    end
+  end
+end

data/spec/unit/resource/serialization/date_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Resource::Serialization::Date do
+  it "converts to date" do
+    subject.class.serialize('2011-07-01').should == Date.new(2011, 07, 01)
+  end
+
+  context "when an invalid value is serialized" do
+    it "raises an error" do
+      expect {subject.class.serialize("not a date")}.to raise_error
+    end
+  end
+end

data/spec/unit/resource/serialization/float_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Resource::Serialization::Float do
+  it "converts to float" do
+    subject.class.serialize('1200.49').should == 1200.49
+  end
+
+  context "when an invalid value is serialized" do
+    it "raises an error" do
+      expect {subject.class.serialize("not a float")}.to raise_error
+    end
+  end
+end

data/spec/unit/resource/serialization/integer_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Resource::Serialization::Integer do
+  it "converts to integer" do
+    subject.class.serialize('1200').should == 1200
+  end
+
+  context "when an invalid value is serialized" do
+    it "raises an error" do
+      expect {subject.class.serialize("not an integer")}.to raise_error
+    end
+  end
+end

data/spec/unit/resource/serialization/string_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Resource::Serialization::String do
+  it "converts value to string" do
+    subject.class.serialize(:something).should == "something"
+  end
+
+  it "returns nil when value is nil" do
+    subject.class.serialize(nil).should be_nil
+  end
+end

data/spec/unit/resource_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Resource do
+  describe '#resource' do
+    before do
+      class Example < Resource
+        property :login
+        property :name
+        property :age, type: Float
+      end
+    end
+
+    it "returns a hash with properties and its values" do
+      example = Example.new(login: 'jackiechan2010', name: 'Jackie Chan', age: 45)
+      example.resource.should == {login: 'jackiechan2010', name: 'Jackie Chan', age: 45}
+    end
+  end
+
+  context "when using not allowed names" do
+    [:resource_id, :resource, :links].each do |unallowed|
+      it "warns when method #{unallowed} is redefined" do
+        output = out do
+          eval <<-RUBY
+            class Example < Resource
+              def #{unallowed}
+              end
+            end
+          RUBY
+        end
+        output.should =~ /^warning: redefining '#{unallowed}' may cause serious problems/
+      end
+
+      %w(property embeds_one embeds_many has_one has_many belongs_to).each do |kind|
+        it "removes method #{unallowed} created by #{kind}" do
+          expect {
+            eval <<-RUBY
+              class Example < Resource
+                #{kind} :#{unallowed}
+              end
+            RUBY
+          }.to raise_error "you can't define a key with name '#{unallowed}'"
+        end
+      end
+    end
+  end
+end

data/spec/unit/response_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Transcriber::Resource::Response do
+  before do
+    class Example < Resource
+      id         :login
+      property   :phone
+      embeds_one :address, class_name: :example_child
+    end
+
+    class ExampleChild < Resource
+      property   :street
+      property   :city
+    end
+  end
+
+  let(:input) do
+    {
+      'login' => 'jackiechan2010',
+      'phone' => '32232188',
+      'address' => {
+        'street' => 'Aurora St.',
+        'city'   => 'Recife'
+      }
+    }
+  end
+
+  describe "#normalize" do
+    context "when one resource is received" do
+      it "returns a resource" do
+        model = Example.parse(input).first
+        Example.normalize(model).with_indifferent_access.should == input.with_indifferent_access
+      end
+    end
+
+    context "when a list of resources is received" do
+      it "returns some resources in an entries array" do
+        model = 3.times.map {Example.parse(input).first}
+        result = {entries: 3.times.map {input}}
+        Example.normalize(model).with_indifferent_access.should == result.with_indifferent_access
+      end
+    end
+  end
+end

data/transcriber.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name        = "transcriber"
   s.version     = Transcriber::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Victor Rodrigues",              "William Yokoi"]
-  s.email       = ["victorcrodrigues@gmail.com",    "thekina@gmail.com"]
+  s.authors     = ["Victor Rodrigues",              "William Yokoi",     "Guilherme Guimarães Filho"]
+  s.email       = ["victorcrodrigues@gmail.com",    "thekina@gmail.com", "guilherme.filho@locaweb.com.br"]
   s.homepage    = "http://github.com/rodrigues/transcriber"
   s.summary     = %q{}
   s.description = %q{}
@@ -18,5 +18,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "activesupport", "~> 3.0"
-  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_dependency "i18n",          "~> 0.6"
+  s.add_development_dependency "rspec",       "~> 2.6"
+  s.add_development_dependency "guard",       "~> 0.5"
+  s.add_development_dependency "guard-rspec", "~> 0.4"
+  s.add_development_dependency "growl",       "~> 1.0"
 end

metadata

@@ -2,16 +2,17 @@
 name: transcriber
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Victor Rodrigues
 - William Yokoi
+- "Guilherme Guimar\xC3\xA3es Filho"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-07-31 00:00:00 -03:00
+date: 2011-08-11 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,20 +27,65 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: i18n
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: "2.6"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.5"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: growl
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :development
+  version_requirements: *id006
 description: ""
 email: 
 - victorcrodrigues@gmail.com
 - thekina@gmail.com
+- guilherme.filho@locaweb.com.br
 executables: []
 
 extensions: []
@@ -49,30 +95,83 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- Guardfile
+- README.md
 - Rakefile
+- examples/all.rb
+- examples/embeds_many/simple.rb
+- examples/embeds_many/with_class_name.rb
+- examples/embeds_many/with_if.rb
+- examples/embeds_many/with_start_key.rb
+- examples/embeds_one/simple.rb
+- examples/embeds_one/with_class_name.rb
+- examples/embeds_one/with_if.rb
+- examples/embeds_one/with_start_key.rb
+- examples/has_many/simple.rb
+- examples/properties/simple.rb
+- examples/properties/with_field.rb
+- examples/properties/with_field_path.rb
+- examples/properties/with_id.rb
+- examples/properties/with_if.rb
+- examples/properties/with_key_converter.rb
 - lib/transcriber.rb
+- lib/transcriber/configuration.rb
 - lib/transcriber/resource.rb
-- lib/transcriber/resource/embeddables.rb
-- lib/transcriber/resource/embeddables/embeddable.rb
-- lib/transcriber/resource/embeddables/parser.rb
-- lib/transcriber/resource/embeddables/resource.rb
+- lib/transcriber/resource/builder.rb
+- lib/transcriber/resource/builder/embeddables.rb
+- lib/transcriber/resource/builder/keys.rb
+- lib/transcriber/resource/builder/properties.rb
+- lib/transcriber/resource/builder/relations.rb
+- lib/transcriber/resource/builder/summarizations.rb
+- lib/transcriber/resource/input_path.rb
+- lib/transcriber/resource/key.rb
+- lib/transcriber/resource/key/association.rb
+- lib/transcriber/resource/key/embeddable.rb
+- lib/transcriber/resource/key/property.rb
+- lib/transcriber/resource/key/relation.rb
 - lib/transcriber/resource/parser.rb
-- lib/transcriber/resource/properties.rb
-- lib/transcriber/resource/properties/parser.rb
-- lib/transcriber/resource/properties/property.rb
-- lib/transcriber/resource/properties/resource.rb
-- lib/transcriber/resource/responses.rb
-- lib/transcriber/resource/serialization.rb
+- lib/transcriber/resource/parser/embeddable.rb
+- lib/transcriber/resource/parser/property.rb
+- lib/transcriber/resource/response.rb
+- lib/transcriber/resource/response/embeddable.rb
+- lib/transcriber/resource/response/property.rb
+- lib/transcriber/resource/response/relation.rb
 - lib/transcriber/resource/serialization/boolean.rb
 - lib/transcriber/resource/serialization/date.rb
 - lib/transcriber/resource/serialization/float.rb
+- lib/transcriber/resource/serialization/integer.rb
 - lib/transcriber/resource/serialization/string.rb
 - lib/transcriber/version.rb
-- spec/resource/embeddables_spec.rb
-- spec/resource/parser_spec.rb
-- spec/resource/properties_spec.rb
-- spec/resource_spec.rb
+- spec/integration/has_many_spec.rb
+- spec/integration/property_spec.rb
 - spec/spec_helper.rb
+- spec/support/examples.rb
+- spec/support/out.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/input_path_spec.rb
+- spec/unit/key_spec.rb
+- spec/unit/parser_spec.rb
+- spec/unit/resource/builder/embeddables_spec.rb
+- spec/unit/resource/builder/properties_spec.rb
+- spec/unit/resource/builder/relations_spec.rb
+- spec/unit/resource/builder/shared_example_for_association.rb
+- spec/unit/resource/builder/summarize_spec.rb
+- spec/unit/resource/key/association_spec.rb
+- spec/unit/resource/key/embeddable_spec.rb
+- spec/unit/resource/key/property_spec.rb
+- spec/unit/resource/key/relation_spec.rb
+- spec/unit/resource/parser/embeddable_spec.rb
+- spec/unit/resource/parser/property_spec.rb
+- spec/unit/resource/response/embeddable_spec.rb
+- spec/unit/resource/response/property_spec.rb
+- spec/unit/resource/response/relation_spec.rb
+- spec/unit/resource/serialization/boolean_spec.rb
+- spec/unit/resource/serialization/date_spec.rb
+- spec/unit/resource/serialization/float_spec.rb
+- spec/unit/resource/serialization/integer_spec.rb
+- spec/unit/resource/serialization/string_spec.rb
+- spec/unit/resource_spec.rb
+- spec/unit/response_spec.rb
 - transcriber.gemspec
 has_rdoc: true
 homepage: http://github.com/rodrigues/transcriber
@@ -103,8 +202,33 @@ signing_key:
 specification_version: 3
 summary: ""
 test_files: 
-- spec/resource/embeddables_spec.rb
-- spec/resource/parser_spec.rb
-- spec/resource/properties_spec.rb
-- spec/resource_spec.rb
+- spec/integration/has_many_spec.rb
+- spec/integration/property_spec.rb
 - spec/spec_helper.rb
+- spec/support/examples.rb
+- spec/support/out.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/input_path_spec.rb
+- spec/unit/key_spec.rb
+- spec/unit/parser_spec.rb
+- spec/unit/resource/builder/embeddables_spec.rb
+- spec/unit/resource/builder/properties_spec.rb
+- spec/unit/resource/builder/relations_spec.rb
+- spec/unit/resource/builder/shared_example_for_association.rb
+- spec/unit/resource/builder/summarize_spec.rb
+- spec/unit/resource/key/association_spec.rb
+- spec/unit/resource/key/embeddable_spec.rb
+- spec/unit/resource/key/property_spec.rb
+- spec/unit/resource/key/relation_spec.rb
+- spec/unit/resource/parser/embeddable_spec.rb
+- spec/unit/resource/parser/property_spec.rb
+- spec/unit/resource/response/embeddable_spec.rb
+- spec/unit/resource/response/property_spec.rb
+- spec/unit/resource/response/relation_spec.rb
+- spec/unit/resource/serialization/boolean_spec.rb
+- spec/unit/resource/serialization/date_spec.rb
+- spec/unit/resource/serialization/float_spec.rb
+- spec/unit/resource/serialization/integer_spec.rb
+- spec/unit/resource/serialization/string_spec.rb
+- spec/unit/resource_spec.rb
+- spec/unit/response_spec.rb

data/lib/transcriber/resource/embeddables/embeddable.rb

@@ -1,31 +0,0 @@
-class Transcriber::Resource
-  class Embeddable
-    autoload :Parser,   'transcriber/resource/embeddables/parser'
-    autoload :Resource, 'transcriber/resource/embeddables/resource'
-    include   Parser
-    include   Resource
-
-    attr_accessor :name
-    attr_accessor :class_name
-    attr_accessor :start_key
-    attr_accessor :many
-    attr_accessor :options
-
-    def initialize(name, options = {})
-      @name = name
-
-      @class_name = (options.delete(:class_name) || name).to_s.camelize
-      @start_key  =  options.delete(:start_key)
-      @many       =  options.delete(:many)
-      @options    =  options
-    end
-
-    def one?
-      !@many
-    end
-
-    def many?
-      @many
-    end
-  end
-end

data/lib/transcriber/resource/embeddables/parser.rb

@@ -1,10 +0,0 @@
-class Transcriber::Resource::Embeddable
-  module Parser
-    def parse(item)
-      options = {}
-      options.merge!(start_key: start_key) if start_key
-      value = class_name.constantize.parse(item, options)
-      one? ? value.first : value
-    end
-  end
-end

data/lib/transcriber/resource/embeddables/resource.rb

@@ -1,9 +0,0 @@
-class Transcriber::Resource::Embeddable
-  module Resource
-    def to_resource(resource)
-      resource = resource.__send__(name)
-      resource = resource.map(&:resource) if resource.kind_of?(Enumerable)
-      {name => resource}
-    end
-  end
-end

data/lib/transcriber/resource/embeddables.rb

@@ -1,18 +0,0 @@
-class Transcriber::Resource
-  module Embeddables
-    def embeds(name, options)
-      attr_accessor name
-      keys << Embeddable.new(name, options)
-    end
-
-    def embeds_one(name, options = {})
-      options.merge!(many: false)
-      embeds(name, options)
-    end
-
-    def embeds_many(name, options = {})
-      options.merge!(many: true)
-      embeds(name, options)
-    end
-  end
-end

data/lib/transcriber/resource/properties/parser.rb

@@ -1,9 +0,0 @@
-class Transcriber::Resource::Property
-  module Parser
-    def parse(item, options = {})
-      value = serializer.serialize(item[field])
-      value = values.key(value) if values
-      value
-    end
-  end
-end

data/lib/transcriber/resource/properties/property.rb

@@ -1,30 +0,0 @@
-class Transcriber::Resource
-  class Property
-    autoload :Parser,   'transcriber/resource/properties/parser'
-    autoload :Resource, 'transcriber/resource/properties/resource'
-    include   Parser
-    include   Resource
-
-    attr_accessor :name
-    attr_accessor :field
-    attr_accessor :serializer
-    attr_accessor :values
-    attr_accessor :options
-
-    def initialize(name, options = {})
-      @name  = name
-      @field = prepare_field(options.delete(:field) || name)
-      @serializer = (options.delete(:type)  || Serialization::String)
-      @values     =  options.delete(:values)
-      @options    =  options
-    end
-
-    def prepare_field(field)
-      field.to_s.upcase # @TODO this logic shouldn't be here.
-                        # it's a key conversion strategy
-                        # convert(field).to_s, convert should be
-                        # an identity function if a custom
-                        # strategy was not set.
-    end
-  end
-end

data/lib/transcriber/resource/properties/resource.rb

@@ -1,7 +0,0 @@
-class Transcriber::Resource::Property
-  module Resource
-    def to_resource(resource)
-      {name => resource.__send__(name)}
-    end
-  end
-end

data/lib/transcriber/resource/properties.rb

@@ -1,8 +0,0 @@
-class Transcriber::Resource
-  module Properties
-    def property(name, options = {})
-      attr_accessor name
-      keys << Property.new(name, options)
-    end
-  end
-end