flatter 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 543de04a22f3559983f3dd01ee360a7f78117df6
-  data.tar.gz: 5e6e173e3c3b60d0109ddb9a898b61fcd756254f
+  metadata.gz: e8c9d3f37b6dfdb2b990df2a47c1682af45a526b
+  data.tar.gz: 83e78ea63b40fcbceea19a6f940f97747a00bd2f
 SHA512:
-  metadata.gz: 8d818795d50e0d5a138e430ad5b1e5c3b4983e93bba7f5a34561592d92a35ca17ac57e3d340f7674f3662602e6a290fcadf7a78482f6b9fb66bdcc288d02655a
-  data.tar.gz: 052590d63bd471a285e3268497189bf14185d9bd24b1a69058a363b550f4370c590239abe7277d29f91247a20b180146ab34bf3264be689897ad1b7bfca71687
+  metadata.gz: bed580ee036c3d9a21ce0c24e293e4472f0664ae6d4f8acbd93cb8a2cbdf8018cf5e5a3e4b5a873e1a7c8cd799ae2a3c100c5bd865792e8141e44c37f063a830
+  data.tar.gz: 8463c12d806db30ad17305ceaaf3b9493e65b9074fff674e21e5b2a3fcfc22f3427d6bfc8f7f73991dbe81fa3cfc96e65806d6b387a3156dbcfd0ef6b86b46f9

data/README.md

@@ -79,15 +79,15 @@ end
 #### Mapping Options
 
 - `:reader` Allows to add a custom logic for reading target's attribute.
-  When value is `String` or `Symbol`, calls a method defined by a **mapper** class.
+  When value is `Symbol`, calls a method defined by a **mapper** class.
   If that method accepts an argument, mapping name will be passed to it.
   When value is `Proc`, it is executed in context of mapper object, yielding
-  mapping name if block has arity of 1. For other arbitrary objects will simply
-  return that object.
+  mapping name if block has arity of 1. For other arbitrary objects (including
+  `String`s) will simply return that object.
 
 - `:writer` Allows to control a way how value is assigned (written).
-  When value is `String` or `Symbol`, calls a method defined by a **mapper** class,
-  passing a value to it. If that method accepts second argument, mapping name will be
+  When value is `Symbol`, calls a method defined by a **mapper** class, passing
+  a value to it. If that method accepts second argument, mapping name will be
   additionally passed to it.
   When value is `Proc`, it is executed in context of mapper object, yielding
   value and optionally mapping name if block has arity of 2. For other values will
@@ -518,14 +518,14 @@ class DepartmentMapper < Flatter::Mapper
 end
 ```
 
-`mapper.first_name` no longer able to return specific value, since it's
+`department_mapper.first_name` no longer able to return specific value, since it's
 not clear which first name should it be. Thus, when mapper is mounted as
 a collection item, instead of singular value accessors you gain pluralized
 reader methods:
 
 ```ruby
   # all first_names of all people of the mapped department:
-  mapper.first_names # => ["John", "Derek"]
+  department_mapper.first_names # => ["John", "Derek"]
 ```
 
 The same concerns for all nested (singular or collection) mappings and mountings
@@ -533,15 +533,15 @@ under collection mapper:
 
 ```ruby
   # all phone number of all people of the mapped department
-  mapper.phone_numbers # => ["111-222-3333", "222-111-33333"]
+  department_mapper.phone_numbers # => ["111-222-3333", "222-111-33333"]
 
   # all the people
-  mapper.people # =>
+  department_mapper.people # =>
   # [{"first_name" => "John", "last_name" => "Smith", "key" => 1, "phone_number" => "111-222-3333"},
   #  {"first_name" => "Derek", "last_name" => "Parker", "key" => 2, "phone_number" => "222-111-3333"}]
 
   # all phones (note the :phone mapper mounted on :people, opposed to it's :phone_number mapping)
-  mapper.phones # =>
+  department_mapper.phones # =>
   # [{"phone_number" => "111-222-3333"}, {"phone_number" => "222-111-33333"}]
 ```
 

data/lib/flatter/mapper/collection.rb

@@ -68,18 +68,24 @@ module Flatter
 
       def add_item(params)
         collection << clone.tap do |mapper|
-          item = target_class.new
+          item = build_collection_item
           mapper.reset_locals!
           mapper.set_target!(item)
           mapper.item_index = collection.length
           mapper.write(params)
-          add_target_item(item)
+          add_item_to_target(item)
         end
       end
 
-      def add_target_item(item)
+      def build_collection_item
+        target_class.new
+      end
+      private :build_collection_item
+
+      def add_item_to_target(item)
         target << item
       end
+      private :add_item_to_target
     end
 
     def read
@@ -96,7 +102,8 @@ module Flatter
       return super unless collection?
       return unless params.key?(name)
 
-      data = params[name]
+      data = extract_data(params)
+
       assert_collection!(data)
 
       keys = collection.map(&:key)
@@ -111,6 +118,11 @@ module Flatter
       end
     end
 
+    def extract_data(params)
+      params[name]
+    end
+    private :extract_data
+
     def pluralize!
       @_pluralized = true
     end

data/lib/flatter/mapper/factory.rb

@@ -15,9 +15,16 @@ module Flatter
     end
 
     def mapper_class
-      options[:mapper_class] || mapper_class_name.constantize
+      options[:mapper_class] || default_mapper_class
     end
 
+    def default_mapper_class
+      mapper_class_name.constantize
+    rescue NameError => e
+      Flatter.default_mapper_class or raise e
+    end
+    private :default_mapper_class
+
     def mapper_class_name
       options[:mapper_class_name] || modulize(default_mapper_class_name)
     end

data/lib/flatter/mapper/model_name.rb

@@ -1,8 +1,7 @@
 module Flatter
   module Mapper::ModelName
     def model_name
-      target.class.respond_to?(:model_name) ?
-        target.class.model_name : super
+      target.class.try(:model_name) || super
     end
   end
 end

data/lib/flatter/mapper/mounting.rb

@@ -60,6 +60,10 @@ module Flatter
       @_inner_mountings = nil
     end
 
+    def root
+      mounter.nil? ? self : mounter.root
+    end
+
     def local_mountings
       class_mountings_for(self.class)
     end

data/lib/flatter/mapper/traits.rb

@@ -27,20 +27,18 @@ module Flatter
         super.tap{ |f| f.extension = block }
       end
 
-      def trait(name, label = nil, &block)
-        trait_name   = "#{name}_trait"
+      def trait(trait_name, label: name, includes: nil, &block)
+        trait_name   = "#{trait_name}_trait"
         mapper_class = Class.new(Flatter::Mapper)
-        mapper_class.label = self.name || label
-        mapper_class.class_eval(&block)
+        mapper_class.label = label
+        mapper_class.class_eval(&block) if block.present?
 
         if self.name.present?
           mapper_class_name = trait_name.camelize
           const_set(mapper_class_name, mapper_class)
-
-          mount trait_name, mapper_class_name: "#{self.name}::#{mapper_class_name}", trait: true
-        else
-          mount trait_name, mapper_class: mapper_class, trait: true
         end
+
+        mount trait_name, mapper_class: mapper_class, trait: true, includes: includes
       end
     end
 
@@ -52,7 +50,7 @@ module Flatter
     end
 
     def extend_with(extension)
-      singleton_class.trait :extension, self.class.name, &extension
+      singleton_class.trait :extension, label: self.class.name, &extension
     end
 
     def full_name
@@ -95,12 +93,40 @@ module Flatter
     end
 
     def trait_names
-      traits.map{ |trait| "#{trait.to_s}_trait" }
+      traits.map{ |trait| trait_name_for(trait) }
     end
 
     def set_traits(traits)
-      @traits = traits
+      @traits = resolve_trait_dependencies(traits)
+    end
+
+    def trait_name_for(trait)
+      "#{trait.to_s}_trait"
+    end
+    private :trait_name_for
+
+    def resolve_trait_dependencies(traits)
+      factories = self.class.mountings.values.select(&:trait?)
+      catch(:done){ loop{ include_traits_from!(traits, factories) } }
+      traits
     end
+    private :resolve_trait_dependencies
+
+    def include_traits_from!(traits, factories)
+      initial_length = traits.length
+      traits.map! do |trait|
+        factory = factories.find{ |f| f.name == trait_name_for(trait) }
+        if factory.present?
+          factories.delete(factory)
+          Array(factory.options[:includes]).push(trait)
+        else
+          trait
+        end
+      end
+      traits.flatten!
+      throw :done if traits.length == initial_length
+    end
+    private :include_traits_from!
 
     def trait?
       !!@trait
@@ -121,7 +147,7 @@ module Flatter
     private :trait_mountings
 
     def shared_methods
-      self.class.public_instance_methods(false)
+      self.class.public_instance_methods(false) + self.class.protected_instance_methods(false)
     end
 
     def respond_to_missing?(name, *)
@@ -132,6 +158,10 @@ module Flatter
       end
     end
 
+    def mounter!
+      trait? ? mounter.mounter : mounter
+    end
+
     def method_missing(name, *args, &block)
       if trait?
         mounter.send(name, *args, &block)

data/lib/flatter/mapping/scribe.rb

@@ -11,7 +11,7 @@ module Flatter
         return super unless reader?
 
         case reader
-        when Proc, String, Symbol
+        when Proc, Symbol
           args = Array((name if arity_of(reader) == 1))
           exec_or_send(reader, args)
         when false then nil
@@ -23,11 +23,11 @@ module Flatter
         return super unless writer?
 
         case writer
-        when Proc, String, Symbol
+        when Proc, Symbol
           args = [value].tap{ |a| a << name if arity_of(writer) == 2 }
           exec_or_send(writer, args)
         when false then nil
-        else fail BadWriterError, "cannot use #{writer} for assigning values"
+        else fail BadWriterError, "cannot use #{writer.inspect} for assigning values"
         end
       end
 

data/lib/flatter/version.rb

@@ -1,3 +1,3 @@
 module Flatter
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/flatter.rb

@@ -13,7 +13,18 @@ module Flatter
 
   use :scribe, require: 'flatter/mapping/scribe'
 
+  mattr_accessor :default_mapper_class
+
   def self.configure
     yield self
   end
+
+  def self.extends(klass, *modules)
+    if block_given?
+      _module = Module.new(&Proc.new)
+      klass.const_set("FlatterExtension", _module)
+      modules.push _module
+    end
+    modules.each{ |mod| klass.send(:include, mod) }
+  end
 end

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: flatter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Artem Kuzko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-25 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: |-
@@ -148,9 +148,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -191,17 +191,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Maps a deeply nested model graph to a single object with a flat set of attributes.