transcriber 0.0.25 → 0.0.26

data/examples/all.rb

@@ -1,4 +1,4 @@
-$:.push 'lib'; require 'transcriber'
+$:.push 'lib'; puts ": #{$:}"; require 'transcriber'
 
 Dir["examples/*/**.rb"].each do |file|
   [:Root, :Item, :Customer, :Entry, :Service].each do |klass|

data/examples/to_input/serializables.rb

@@ -0,0 +1,23 @@
+$:.push 'lib'; require 'transcriber'
+
+Transcriber.configure do |c|
+  c.true_value = "X"
+  c.false_value = ""
+  c.date_format = "%Y%m%d"
+end
+
+class Customer < Transcriber::Resource
+  property :login
+  property :age,      type: Integer
+  property :birth,    type: Date
+  property :active,   type: Boolean
+  property :services, type: Enumerable
+  property :balance,  type: Float
+end
+
+@root = Customer.new({login: 'jackiechan2010', age: 22, birth: "1990-07-04", active: true, services: ["Hosting", "Email"], balance: 200.00})
+
+puts "root.to_input: #{@root.to_input}"
+
+puts "root:     #{@root.inspect}"
+puts "resource: #{@root.resource}"

data/lib/transcriber.rb

@@ -1,42 +1,34 @@
-require 'date'
-require 'active_support/inflector'
-require 'active_support/concern'
-require 'active_support/core_ext/class/attribute_accessors'
-require 'active_support/core_ext/object/try'
-require 'active_support/core_ext/array/wrap'
-require 'active_support/core_ext/hash/slice'
+require "date"
+require "active_support/inflector"
+require "active_support/concern"
+require "active_support/core_ext/class/attribute_accessors"
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/array/wrap"
+require "active_support/core_ext/hash/slice"
 require "active_support/core_ext/hash/indifferent_access"
 
-require 'transcriber/resource/input_path'
-require 'transcriber/resource/input_parser'
-require 'transcriber/resource/parser'
-require 'transcriber/resource/response'
-require 'transcriber/resource/serialization/boolean'
-require 'transcriber/resource/serialization/date'
-require 'transcriber/resource/serialization/enumerable'
-require 'transcriber/resource/serialization/float'
-require 'transcriber/resource/serialization/integer'
-require 'transcriber/resource/serialization/string'
-require 'transcriber/resource/key'
-require 'transcriber/resource/parser/property'
-require 'transcriber/resource/parser/embeddable'
-require 'transcriber/resource/response/property'
-require 'transcriber/resource/response/embeddable'
-require 'transcriber/resource/response/relation'
-require 'transcriber/resource/response/href'
-require 'transcriber/resource/key/property'
-require 'transcriber/resource/key/association'
-require 'transcriber/resource/key/relation'
-require 'transcriber/resource/key/embeddable'
-require 'transcriber/resource/key/href'
-require 'transcriber/resource/builder/keys'
-require 'transcriber/resource/builder/relations'
-require 'transcriber/resource/builder/embeddables'
-require 'transcriber/resource/builder/properties'
-require 'transcriber/resource/builder/summarizations'
-require 'transcriber/resource/builder'
-require 'transcriber/resource'
-require 'transcriber/configuration'
+require "transcriber/resource/input_path"
+require "transcriber/resource/input_parser"
+require "transcriber/resource/parser"
+require "transcriber/resource/response"
+require "transcriber/resource/serialization/boolean"
+require "transcriber/resource/serialization/date"
+require "transcriber/resource/serialization/enumerable"
+require "transcriber/resource/serialization/float"
+require "transcriber/resource/serialization/integer"
+require "transcriber/resource/serialization/string"
+require "transcriber/resource/key"
+require "transcriber/resource/key/property"
+require "transcriber/resource/key/property/builder"
+require "transcriber/resource/key/association"
+require "transcriber/resource/key/relation"
+require "transcriber/resource/key/relation/builder"
+require "transcriber/resource/key/embeddable"
+require "transcriber/resource/key/embeddable/builder"
+require "transcriber/resource/key/href"
+require "transcriber/resource/builder"
+require "transcriber/resource"
+require "transcriber/configuration"
 
 module Transcriber
   def self.configuration

data/lib/transcriber/configuration.rb

@@ -2,7 +2,7 @@ module Transcriber
   class Configuration
     attr_accessor :host
 
-    DefaultHandler = lambda {|keys| keys}
+    DefaultHandler = proc {|keys| keys}
 
     def convert_input_keys
       @convert_input_keys || DefaultHandler
@@ -11,5 +11,29 @@ module Transcriber
     def convert_input_keys=(converter)
       @convert_input_keys = converter
     end
+
+    def true_value
+      @true || true
+    end
+
+    def true_value=(value)
+      @true = value
+    end
+
+    def false_value
+      @false || false
+    end
+
+    def false_value=(value)
+      @false = value
+    end
+
+    def date_format
+      @date_format
+    end
+
+    def date_format=(format)
+      @date_format = format
+    end
   end
 end

data/lib/transcriber/resource/builder.rb

@@ -1,11 +1,30 @@
 module Transcriber
   class Resource
     module Builder
-      include Keys
-      include Relations
-      include Embeddables
-      include Properties
-      include Summarizations
+      include Relation::Builder
+      include Embeddable::Builder
+      include Property::Builder
+
+      def key(key)
+        fail "you can't define a key with name '#{key.name}'" if not_allowed?(key)
+        key.model = self
+        attr_accessor key.name
+        self.keys  << key
+        self.id_key = key if key.options[:id]
+      end
+
+      def summarizes(*args)
+        args.each do |name|
+          key = keys.find {|key| key.name == name}
+          summarized_keys << key if key
+        end
+      end
+
+      private
+
+      def not_allowed?(key)
+        Resource.not_allowed_names.include?(key.name.to_s)
+      end
     end
   end
 end

data/lib/transcriber/resource/input_parser.rb

@@ -1,13 +1,19 @@
 module Transcriber
   class Resource
     module InputParser
+      def to_input!(options = {})
+        to_input(options.merge(fail: true))
+      end
+
       def to_input(options = {})
         input = {}
+        propagatable_options = {without_nil: options[:without_nil],
+                                fail: options[:fail]}
 
         keys_to_input(options).each do |key|
           value = __send__(key.name)
-          key_options = options.fetch(key.name, {without_nil: options[:without_nil]})
-          input.merge! key.to_input(value, self, key_options)
+          key_options = options.fetch(key.name, {}).merge(propagatable_options)
+          input.merge! key.to_input!(value, self, key_options)
         end
 
         input.with_indifferent_access

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

@@ -1,8 +1,10 @@
 module Transcriber
   class Resource
     class Embeddable < Association
-      include Parser::Embeddable
-      include Response::Embeddable
+      autoload :Parser,   "transcriber/resource/key/embeddable/parser"
+      autoload :Response, "transcriber/resource/key/embeddable/response"
+      include Parser
+      include Response
 
       attr_accessor :fields
 

data/lib/transcriber/resource/{builder/embeddables.rb → key/embeddable/builder.rb}

@@ -1,7 +1,7 @@
 module Transcriber
   class Resource
-    module Builder
-      module Embeddables
+    class Embeddable
+      module Builder
         def embeds(name, options = {})
           key Embeddable.new(name, options)
         end

data/lib/transcriber/resource/{parser/embeddable.rb → key/embeddable/parser.rb}

@@ -1,7 +1,7 @@
 module Transcriber
   class Resource
-    module Parser
-      module Embeddable
+    class Embeddable
+      module Parser
         def parse(item, resource = nil)
           return parse_fields(item) if fields
           value = digg(item)
@@ -21,7 +21,7 @@ module Transcriber
           raw? ? attrs : super
         end
 
-        def to_input(value, resource, options = {})
+        def to_input!(value, resource, options = {})
           return {} if value.nil?
           fields ? to_multiple_input(value, options)
                  : to_single_input(value, options)

data/lib/transcriber/resource/{response/embeddable.rb → key/embeddable/response.rb}

@@ -1,7 +1,7 @@
 module Transcriber
   class Resource
-    module Response
-      module Embeddable
+    class Embeddable
+      module Response
         def to_resource(parent)
           return {} unless visible?(parent)
           resource = nil

data/lib/transcriber/resource/key/href.rb

@@ -1,7 +1,8 @@
 module Transcriber
   class Resource
     class Href < Key
-      include Response::Href
+      autoload :Response, "transcriber/resource/key/href/response"
+      include Response
 
       def initialize
         super(:href)

data/lib/transcriber/resource/{response/href.rb → key/href/response.rb}

@@ -1,7 +1,7 @@
 module Transcriber
   class Resource
-    module Response
-      module Href
+    class Href
+      module Response
         def to_resource(parent)
           id_key = parent.class.id_key.name
           {name => "#{Transcriber.host}/#{parent.class.resource_name}/#{parent.send(id_key)}"}

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

@@ -1,8 +1,10 @@
 module Transcriber
   class Resource
     class Property < Key
-      include Parser::Property
-      include Response::Property
+      autoload :Parser,   "transcriber/resource/key/property/parser"
+      autoload :Response, "transcriber/resource/key/property/response"
+      include Parser
+      include Response
 
       attr_accessor :serializer, :translations
 

data/lib/transcriber/resource/{builder/properties.rb → key/property/builder.rb}

@@ -1,7 +1,7 @@
 module Transcriber
   class Resource
-    module Builder
-      module Properties
+    class Property
+      module Builder
         def property(name, options = {})
           key Property.new(name, options)
         end

data/lib/transcriber/resource/{parser/property.rb → key/property/parser.rb}

@@ -1,7 +1,7 @@
 module Transcriber
   class Resource
-    module Parser
-      module Property
+    class Property
+      module Parser
         def parse(item, resource = nil)
           value = digg(item)
           translate_from_input(serializer.serialize(value), resource)
@@ -14,16 +14,19 @@ module Transcriber
         def translate_from_input(value, resource)
           case translations
           when nil  then value
-          when Hash then translations.key(value)
           when Proc then resource.instance_eval(&translations)
+          when Hash
+            fail "from input error" unless translations.has_value?(value)
+            translations.key(value)
           end
         end
 
         def translate_to_input(value, resource)
           case translations
-          when nil  then value
-          when Hash then translations[value]
           when Proc then resource.instance_eval(&translations)
+          when Hash
+            fail "to input error" unless translations.has_key?(value)
+            translations[value]
           end
         end
 
@@ -31,17 +34,28 @@ module Transcriber
           value
         end
 
-        def to_input(value, resource, options = {});
-          value = translate_to_input(value, resource)
+        def to_input!(value, resource, options = {})
+          input_value = nil
+
+          begin
+            if translations
+              input_value = translate_to_input(value, resource)
+            else
+              input_value = serializer.desserialize(value)
+            end
+          rescue => exception
+            raise exception if options[:fail]
+          end
+
           input = {}
           path = input_path
 
           if path.any?
             last = path.pop
             key_input = path.inject(input) {|buffer, key| buffer[key] = {}; buffer[key]}
-            key_input[last] = value
+            key_input[last] = input_value
           else
-            input.merge!(value)
+            input.merge!(input_value)
           end
 
           input

data/lib/transcriber/resource/{response/property.rb → key/property/response.rb}

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

data/lib/transcriber/resource/key/relation.rb

@@ -1,7 +1,8 @@
 module Transcriber
   class Resource
     class Relation < Association
-      include Response::Relation
+      autoload :Response, "transcriber/resource/key/relation/response"
+      include Response
 
       def initialize(name, options = {})
         super

data/lib/transcriber/resource/{builder/relations.rb → key/relation/builder.rb}

@@ -1,7 +1,7 @@
 module Transcriber
   class Resource
-    module Builder
-      module Relations
+    class Relation
+      module Builder
         def relation(name, options = {})
           key Relation.new(name, options)
         end

data/lib/transcriber/resource/{response/relation.rb → key/relation/response.rb}

@@ -1,7 +1,7 @@
 module Transcriber
   class Resource
-    module Response
-      module Relation
+    class Relation
+      module Response
         def to_resource(parent)
           included = parent.__send__(name)
           return {} unless visible?(parent) and included

data/lib/transcriber/resource/serialization/boolean.rb

@@ -31,6 +31,19 @@ module Transcriber
             fail "value not serializable: #{value}" if bool.nil?
           end
         end
+
+        def self.desserialize(value)
+          fail unless boolean?(value)
+
+          value ? Transcriber.configuration.true_value
+                : Transcriber.configuration.false_value
+        end
+
+        private
+
+        def self.boolean?(value)
+          !!value == value
+        end
       end
     end
   end

data/lib/transcriber/resource/serialization/date.rb

@@ -7,6 +7,14 @@ module Transcriber
         rescue ArgumentError
           raise "value not serializable: #{value}"
         end
+
+        def self.desserialize(value)
+          date = value.kind_of?(::Date) ? value : ::Date.parse(value)
+          format = Transcriber.configuration.date_format
+          format ? date.strftime(format) : date.to_s
+        rescue ArgumentError
+          raise "value not desserializable: #{value}"
+        end
       end
     end
   end

data/lib/transcriber/resource/serialization/enumerable.rb

@@ -6,6 +6,11 @@ module Transcriber
           fail "value not serializable: #{value}" unless value.kind_of?(::Enumerable)
           value
         end
+
+        def self.desserialize(value)
+          fail "value not desserializable: #{value}" unless value.kind_of?(::Enumerable)
+          value
+        end
       end
     end
   end

data/lib/transcriber/resource/serialization/float.rb

@@ -7,6 +7,12 @@ module Transcriber
         rescue ArgumentError
           raise "value not serializable: #{value}"
         end
+
+        def self.desserialize(value)
+          Float(value)
+        rescue ArgumentError
+          raise "value not desserializable: #{value}"
+        end
       end
     end
   end

data/lib/transcriber/resource/serialization/integer.rb

@@ -7,6 +7,12 @@ module Transcriber
         rescue ArgumentError
           raise "value not serializable: #{value}"
         end
+
+        def self.desserialize(value)
+          Integer(value)
+        rescue ArgumentError
+          raise "value not desserializable: #{value}"
+        end
       end
     end
   end

data/lib/transcriber/resource/serialization/string.rb

@@ -5,6 +5,10 @@ module Transcriber
         def self.serialize(value)
           value.nil? ? nil : value.to_s
         end
+
+        def self.serialize(value)
+          value.nil? ? nil : value.to_s
+        end
       end
     end
   end

data/lib/transcriber/version.rb

@@ -1,3 +1,3 @@
 module Transcriber
-  VERSION = "0.0.25"
+  VERSION = "0.0.26"
 end

data/spec/unit/resource/builder/embeddables_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'unit/resource/builder/shared_example_for_association'
 
-describe Resource::Builder::Embeddables do
+describe Resource::Embeddable::Builder do
   before do
     class Example < Transcriber::Resource
       embeds_one  :contract,      some_option: 'contract options'

data/spec/unit/resource/builder/properties_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Resource::Builder::Properties do
+describe Resource::Property::Builder do
   shared_examples_for "a property" do
     it "defines an attr_accessor with property name" do
       Example.new.tap do |example|

data/spec/unit/resource/builder/relations_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'unit/resource/builder/shared_example_for_association'
 
-describe Resource::Builder::Relations do
+describe Resource::Relation::Builder do
   describe ".has_one" do
     before do
       class Example < Transcriber::Resource

data/spec/unit/resource/parser/embeddable_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Resource::Parser::Embeddable do
+describe Resource::Embeddable::Parser do
   context "when it embeds one" do
     before do
       class ExampleChild < Resource

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

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Resource::Parser::Property do
+describe Resource::Property::Parser do
   subject {Resource::Property.new(:login)}
 
   let(:item)            {{login: "jackiechan2010"}}

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

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Resource::Response::Embeddable do
+describe Resource::Embeddable::Response do
   before do
     class ExampleChild < Resource
       property :id

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

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Resource::Response::Property do
+describe Resource::Property::Response do
   class Customer
     attr_accessor :login
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transcriber
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.26
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-26 00:00:00.000000000Z
+date: 2011-10-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70247910656520 !ruby/object:Gem::Requirement
+  requirement: &70153480625580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70247910656520
+  version_requirements: *70153480625580
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70247910656020 !ruby/object:Gem::Requirement
+  requirement: &70153480624980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70247910656020
+  version_requirements: *70153480624980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70247899184700 !ruby/object:Gem::Requirement
+  requirement: &70153480616320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70247899184700
+  version_requirements: *70153480616320
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70247899184240 !ruby/object:Gem::Requirement
+  requirement: &70153480615520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: '0.5'
   type: :development
   prerelease: false
-  version_requirements: *70247899184240
+  version_requirements: *70153480615520
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70247899183780 !ruby/object:Gem::Requirement
+  requirement: &70153480614880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,10 +67,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70247899183780
+  version_requirements: *70153480614880
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70247899183320 !ruby/object:Gem::Requirement
+  requirement: &70153480614320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -78,7 +78,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70247899183320
+  version_requirements: *70153480614320
 description: ''
 email:
 - victorcrodrigues@gmail.com
@@ -128,6 +128,7 @@ files:
 - examples/to_input/embeds_one.rb
 - examples/to_input/embeds_one_without_key.rb
 - examples/to_input/flattened.rb
+- examples/to_input/serializables.rb
 - examples/to_input/simple.rb
 - examples/to_input/with_field.rb
 - examples/to_input/with_field_path.rb
@@ -138,27 +139,25 @@ files:
 - lib/transcriber/configuration.rb
 - lib/transcriber/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_parser.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/embeddable/builder.rb
+- lib/transcriber/resource/key/embeddable/parser.rb
+- lib/transcriber/resource/key/embeddable/response.rb
 - lib/transcriber/resource/key/href.rb
+- lib/transcriber/resource/key/href/response.rb
 - lib/transcriber/resource/key/property.rb
+- lib/transcriber/resource/key/property/builder.rb
+- lib/transcriber/resource/key/property/parser.rb
+- lib/transcriber/resource/key/property/response.rb
 - lib/transcriber/resource/key/relation.rb
+- lib/transcriber/resource/key/relation/builder.rb
+- lib/transcriber/resource/key/relation/response.rb
 - lib/transcriber/resource/parser.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/href.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/enumerable.rb

data/lib/transcriber/resource/builder/keys.rb

@@ -1,21 +0,0 @@
-module Transcriber
-  class Resource
-    module Builder
-      module Keys
-        def key(key)
-          fail "you can't define a key with name '#{key.name}'" if not_allowed?(key)
-          key.model = self
-          attr_accessor key.name
-          self.keys  << key
-          self.id_key = key if key.options[:id]
-        end
-
-        private
-
-        def not_allowed?(key)
-          Resource.not_allowed_names.include?(key.name.to_s)
-        end
-      end
-    end
-  end
-end

data/lib/transcriber/resource/builder/summarizations.rb

@@ -1,14 +0,0 @@
-module Transcriber
-  class Resource
-    module Builder
-      module Summarizations
-        def summarizes(*args)
-          args.each do |name|
-            key = keys.find {|key| key.name == name}
-            summarized_keys << key if key
-          end
-        end
-      end
-    end
-  end
-end