yaoc 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 441263ba3b9fe09627de69b63629026703c7070d
-  data.tar.gz: 48c6614551a01d37000e914bd48308aca9987424
+  metadata.gz: 409ba0cb455bbdea76b8dd9f32bd81c5d7d8a6bf
+  data.tar.gz: 37de097336722ccd09c26c44f943a6161355ae9f
 SHA512:
-  metadata.gz: d6284f7e096825e82d6244e75eb239a1ef2d388bce4714c71d844619cbd0a71d8923770134947ee81e90a544c67255a9146ff463005794b28f53731f98cc772f
-  data.tar.gz: cc8596b471a03029d0edf21f96dec0e47a1df2a5586ed496c331c9b260a7ea39af0aec3193d8d0d0e81f2a7dd658b3547398727b89c0b911c9155d5f86c304b4
+  metadata.gz: 1258d989f4d14f28c806c45daac46516d0277e471906583ad999d68a662b09deb792118fc9675a06b9df50c12ecfa558a1631d5c2226d26009d10c16d485c389
+  data.tar.gz: b3969999352325fe98045f0b2e5d3edd153f1b12915822a93a1b44f776893a2963cf943fed7103462c882b6a845df1c64f1e79404fabbee408dfc85e7956615a

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+coverage

data/Gemfile

@@ -3,3 +3,5 @@ ruby "2.1.0"
 
 # Specify your gem's dependencies in yaoc.gemspec
 gemspec
+
+gem 'simplecov', require:  false, group: :test

data/README.md

@@ -20,6 +20,8 @@ Or install it yourself as:
 
 Uptodate doc's look into the specs.
 
+### The resulting classes have hash enabled constructors?
+
 ```ruby
 
 require 'yaoc'
@@ -84,9 +86,12 @@ puts mapper.dump(new_user)
 #<struct User id=1, firstname="myfirst", lastname="mysecond", role="admin">
 #<struct OldUser id=1, fullname="no name", r_role="admin">
 
-# the resulting class has no hash enabled constructor?
 
-puts "\n" * 5
+```
+
+### The resulting classes have no hash enabled constructor?
+
+```ruby
 
 OldUser2 = Struct.new(:id, :fullname, :r_role)
 
@@ -144,9 +149,60 @@ puts mapper.dump(new_user2)
 
 ```
 
+### But my classes have positional constructor, what now?
+
+```ruby
+OldUser3 = Struct.new(:id, :fullname, :r_role)
+User3 = Struct.new(:id, :firstname, :lastname, :role)
+
+
+mapper = Yaoc::ObjectMapper.new(User3, OldUser3).tap do |mapper|
+  mapper.add_mapping do
+    fetcher :public_send
+
+    strategy :to_array_mapping
+    reverse_strategy :to_array_mapping
+
+    rule to: 0, from: :id,
+         reverse_to: 0, reverse_from: :id
+
+    rule to: 1,
+         from: :fullname,
+
+         converter: ->(source, result){ result[1] = source.fullname.split().first  },
+         reverse_converter: ->(source, result){ result[1] =  "#{source.firstname} #{source.lastname}" }
+
+    rule to: 2,
+         from: :fullname,
+
+         converter: ->(source, result){ result[2]  = source.fullname.split().last },
+         reverse_converter: ->(source, result){ result }
+
+    rule to: 3, from: :r_role,
+         reverse_to: 2, reverse_from: :role
+  end
+end
+
+old_user3 = OldUser3.new(1, "myfirst mysecond",  "admin" )
+new_user3 = mapper.load(old_user)
+
+puts old_user3
+puts new_user3
+
+new_user3.firstname = "no"
+new_user3.lastname = "name"
+
+puts mapper.dump(new_user3)
+
+#<struct OldUser3 id=1, fullname="myfirst mysecond", r_role="admin">
+#<struct User3 id=1, firstname="myfirst", lastname="mysecond", role="admin">
+#<struct OldUser3 id=1, fullname="no name", r_role="admin">
+
+```
+
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/yaoc/fork )
+1. Fork it ( http://github.com/slowjack2k/yaoc/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1 +1,13 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+
+desc "Run RSpec with code coverage"
+task :coverage do
+  ENV['COVERAGE'] = "true"
+  Rake::Task["spec"].execute
+end

data/lib/yaoc/converter_builder.rb

@@ -1,12 +1,14 @@
 module Yaoc
 
   class ConverterBuilder
-    attr_accessor  :build_commands, :command_order
+    attr_accessor  :build_commands, :command_order, :strategy, :all_commands_applied
 
     def initialize(command_order=:recorded_order, fetcher=:fetch)
       self.build_commands = []
       self.command_order = command_order
       self.fetcher = fetcher
+      self.strategy = :to_hash_mapping
+      self.all_commands_applied = false
     end
 
     def add_mapping(&block)
@@ -14,15 +16,9 @@ module Yaoc
       apply_commands!
     end
 
-    def converter_class
-      @converter_class ||= Struct.new(:to_convert, :fetcher) do
-        include MappingBase
-        include Strategies::ToHashMapping
-      end
-    end
-
-
     def rule(to: nil, from: to, converter: nil)
+      self.all_commands_applied = false
+
       to_s = Array(to)
       from_s = Array(from)
       converter_s = Array(converter)
@@ -34,11 +30,13 @@ module Yaoc
 
     def apply_commands!
       reset_converters!
+      self.all_commands_applied = true
 
       build_commands_ordered.each &:call
     end
 
     def converter(fetch_able)
+      raise "BuildCommandsNotExecuted" unless self.all_commands_applied?
       converter_class.new(fetch_able, fetcher)
     end
 
@@ -48,6 +46,30 @@ module Yaoc
 
     protected
 
+    def converter_class
+      @converter_class ||= Struct.new(:to_convert, :fetcher) do
+        include MappingBase
+      end.tap do |new_class|
+        new_class.send(:include, strategy_module)
+      end
+    end
+
+    def strategy_module
+      Yaoc::Strategies.const_get sym_as_module_name(strategy)
+    end
+
+    def sym_as_module_name(sym)
+      sym.to_s
+         .split("_")
+         .map(&:capitalize)
+         .join()
+         .to_sym
+    end
+
+    def all_commands_applied?
+      all_commands_applied
+    end
+
     def fetcher
       @fetcher ||= :fetch
     end
@@ -56,6 +78,10 @@ module Yaoc
       self.fetcher = new_fetcher
     end
 
+    def with_strategy(new_strategy)
+      self.strategy = new_strategy
+    end
+
     def build_commands_ordered
       if command_order == :recorded_order
         build_commands

data/lib/yaoc/object_mapper.rb

@@ -4,16 +4,18 @@ module Yaoc
     attr_accessor :load_result_source, :dump_result_source
 
     def initialize(load_result_source, dump_result_source=->(attrs){ attrs})
-      self.load_result_source = load_result_source.respond_to?(:call) ? load_result_source : ->(attrs){load_result_source.new(attrs)}
-      self.dump_result_source = dump_result_source.respond_to?(:call) ? dump_result_source : ->(attrs){dump_result_source.new(attrs)}
+      self.load_result_source = load_result_source.respond_to?(:call) ? load_result_source : ->(*attrs){load_result_source.new(*attrs)}
+      self.dump_result_source = dump_result_source.respond_to?(:call) ? dump_result_source : ->(*attrs){dump_result_source.new(*attrs)}
     end
 
     def load(fetch_able)
-      load_result_source.call(converter(fetch_able).call())
+      converter_result = converter(fetch_able).call()
+      call_constructor(load_result_source, converter_result)
     end
 
     def dump(object)
-      dump_result_source.call(reverse_converter(object).call())
+      converter_result = reverse_converter(object).call()
+      call_constructor(dump_result_source, converter_result)
     end
 
     def add_mapping(&block)
@@ -23,12 +25,22 @@ module Yaoc
 
     protected
 
+    def call_constructor(call_able, args)
+      if args.is_a? Array
+        call_able.call(*args)
+      else
+        call_able.call(args)
+      end
+    end
+
     def apply_commands
       converter_builder.apply_commands!
       reverse_converter_builder.apply_commands!
     end
 
-    def rule(to: nil, from: to, converter: nil, reverse_converter: nil)
+    def rule(to: nil, from: to, converter: nil,
+             reverse_to: from, reverse_from: to, reverse_converter: nil)
+
       converter_builder.rule(
           to: to,
           from: from,
@@ -36,8 +48,8 @@ module Yaoc
       )
 
       reverse_converter_builder.rule(
-          to: from,
-          from: to,
+          to: reverse_to,
+          from: reverse_from,
           converter: reverse_converter,
       )
     end
@@ -50,6 +62,14 @@ module Yaoc
       reverse_converter_builder.fetcher = new_fetcher
     end
 
+    def strategy(new_strategy)
+      converter_builder.strategy = new_strategy
+    end
+
+    def reverse_strategy(new_strategy)
+      reverse_converter_builder.strategy = new_strategy
+    end
+
     def converter(fetch_able)
       converter_builder.converter(fetch_able)
     end

data/lib/yaoc/version.rb

@@ -1,3 +1,3 @@
 module Yaoc
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/acceptance/map_objects_spec.rb

@@ -51,7 +51,7 @@ feature "Map objects", %q{
     end
   }
 
-  given(:input_hash){
+  given(:input_object){
     dump_result_object
   }
 
@@ -66,7 +66,7 @@ feature "Map objects", %q{
   scenario "creates an result object from an input_object" do
     load_result_object.name += " Hello World"
 
-    expect(mapper.load(input_hash)).to eq load_result_object
+    expect(mapper.load(input_object)).to eq load_result_object
   end
 
   scenario "dumps an result object as result object" do

data/spec/acceptance/map_to_objects_with_positional_constructors_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+feature "Map objects", %q{
+   In order to map objects with positional constructors
+   as a lib user
+   I want to map object from an input object to an output object and reverse with a given mapping strategy
+} do
+
+  given(:mapper){
+    Yaoc::ObjectMapper.new(load_result_object_class, dump_result_object_class).tap do |mapper|
+      mapper.add_mapping do
+        fetcher :public_send
+        reverse_fetcher :public_send
+
+        strategy :to_array_mapping
+
+        rule to: 0, from: :id,
+             reverse_from: :id
+
+        rule to: 1, from: :name,
+             reverse_from: :name
+      end
+    end
+  }
+
+  given(:load_result_object_class) {
+    Struct.new(:id, :name) do
+      include Equalizer.new(:id, :name)
+    end
+  }
+
+  given(:dump_result_object_class) {
+    Struct.new(:id, :name) do
+      include Equalizer.new(:id, :name)
+
+      def initialize(params={})
+        super()
+
+        params.each do |attr, value|
+          self.public_send("#{attr}=", value)
+        end if params
+      end
+
+    end
+  }
+
+  given(:input_object){
+    dump_result_object
+  }
+
+  given(:load_result_object){
+    load_result_object_class.new(1,"paul")
+  }
+
+  given(:dump_result_object){
+    dump_result_object_class.new({id: 1, name: "paul"})
+  }
+
+  scenario "creates an result object from an input_object" do
+    expect(mapper.load(input_object)).to eq load_result_object
+  end
+
+  scenario "dumps an result object as result object" do
+    expect(mapper.dump(load_result_object)).to eq dump_result_object
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,6 +1,22 @@
 require 'bundler/setup'
 Bundler.require(:development)
 
+
+begin
+  if ENV["COVERAGE"]
+    require 'simplecov'
+    SimpleCov.start do
+      add_group "Lib", "lib"
+
+      add_filter "/spec/"
+    end
+  end
+rescue LoadError
+  warn "=" * 80
+  warn 'simplecov not installed. No coverage report'
+  warn "=" * 80
+end
+
 require 'yaoc'
 
 Dir[File.join(File.expand_path(__dir__ ), "support/**/*.rb")].each { |f| require f }

data/spec/unit/lib/yaoc/converter_builder_spec.rb

@@ -48,19 +48,18 @@ describe Yaoc::ConverterBuilder do
 
   describe "#add_mapping" do
 
-
-
     it "delegates to internal methods" do
-      expect(subject).to receive(:fetch_with).with(:public_send)
       expect(subject).to receive(:rule).with(to: :id, from: :from, converter: :converter)
 
       subject.add_mapping do
         fetch_with  :public_send
+        with_strategy :to_array_mapping
         rule to: :id, from: :from, converter: :converter
       end
-    end
-
 
+      expect(subject.send :fetcher).to eq(:public_send)
+      expect(subject.strategy).to eq(:to_array_mapping)
+    end
 
   end
 
@@ -95,7 +94,7 @@ describe Yaoc::ConverterBuilder do
       end
     end
 
-    it "use the right to when from in arrays is missing" do
+    it "use the right 'to' when 'from' in arrays is missing" do
       expect(converter_class).to receive(:map).ordered.with(:id, :r_id, nil)
       expect(converter_class).to receive(:map).ordered.with(:name, :name, nil)
 
@@ -105,4 +104,22 @@ describe Yaoc::ConverterBuilder do
       end
     end
   end
+
+  describe "#converter" do
+    it "creates a new converter class with the wanted strategy" do
+      subject = Yaoc::ConverterBuilder.new()
+      subject.add_mapping do
+        with_strategy :to_array_mapping
+      end
+
+      expect(subject.converter({})).to be_kind_of Yaoc::Strategies::ToArrayMapping
+    end
+
+    it "raises an exception when not all commands are applied" do
+      subject = Yaoc::ConverterBuilder.new()
+      subject.strategy = :to_array_mapping
+
+      expect{subject.converter({})}.to raise_exception
+    end
+  end
 end

data/spec/unit/lib/yaoc/mapping_base_spec.rb

@@ -21,6 +21,13 @@ describe Yaoc::MappingBase do
     end
   }
 
+  describe "created module" do
+    it "can be inspected" do
+      subject.map(:foo, :bar)
+      expect(subject.class_private_module.inspect).to include("map_0000_bar_to_foo")
+    end
+  end
+
   describe ".map" do
 
     it "creates a bunch of mapping methods" do

data/spec/unit/lib/yaoc/object_mapper_spec.rb

@@ -62,6 +62,14 @@ describe Yaoc::ObjectMapper do
 
     end
 
+    it "accepts a reverse mapping for from and to" do
+      expect(reverse_converter_builder).to receive(:rule).with(to: :id_r, from: :id_r, converter: nil)
+
+      subject.add_mapping do
+        rule to: :id, reverse_to: :id_r, reverse_from: :id_r
+      end
+    end
+
     it "allows to set a fetcher" do
       expect(converter_builder).to receive(:fetcher=).with(:public_send)
 
@@ -81,6 +89,24 @@ describe Yaoc::ObjectMapper do
         rule to: :id
       end
     end
+
+    it "allows to change the strategy" do
+      expect(converter_builder).to receive(:strategy=).with(:to_array_mapping)
+
+      subject.add_mapping do
+        strategy :to_array_mapping
+        rule to: 0, from: :id
+      end
+    end
+
+    it "allows to change the reverse strategy" do
+      expect(reverse_converter_builder).to receive(:strategy=).with(:to_array_mapping)
+
+      subject.add_mapping do
+        reverse_strategy :to_array_mapping
+        rule to: :id, from: 0
+      end
+    end
   end
 
   describe "#load" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaoc
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Dieter Späth
@@ -227,6 +227,7 @@ files:
 - lib/yaoc/strategies/to_hash_mapping.rb
 - lib/yaoc/version.rb
 - spec/acceptance/map_objects_spec.rb
+- spec/acceptance/map_to_objects_with_positional_constructors_spec.rb
 - spec/spec_helper.rb
 - spec/support/feature.rb
 - spec/unit/lib/yaoc/converter_builder_spec.rb
@@ -261,6 +262,7 @@ specification_version: 4
 summary: Yet another object converter
 test_files:
 - spec/acceptance/map_objects_spec.rb
+- spec/acceptance/map_to_objects_with_positional_constructors_spec.rb
 - spec/spec_helper.rb
 - spec/support/feature.rb
 - spec/unit/lib/yaoc/converter_builder_spec.rb