virtus-mapper 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6d3dd7f2d82df13a3cf325565bf29661a41be65
+  data.tar.gz: abaf9425991ef6d6490147d12e6fbb6364a6b71b
+SHA512:
+  metadata.gz: 6ac467f783e37e77253df86073802a90f0b1b0fc07b8a6fb4e35c0e840708f13947a2190e7c9a0071c332372433d3d2a249ad05e90d355fa13ff08cb04e2ae42
+  data.tar.gz: a8a66858592778990e52e7462847205516191bd7c324981887aec292a1448d052699daab8d07b632697ef7a3de4d242baecdf018ec6b4774cc54baeffc78447c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+source 'http://gems.idg.primedia.com'
+
+# Specify your gem's dependencies in virtus-mapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TJ Stankus
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Virtus::Mapper
+
+Mapper for Virtus attributes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'virtus-mapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install virtus-mapper
+
+## Usage
+
+In your Virtus attributes, set the `:from` option to a symbol to translate keys
+on object initialization. In the example below, `:surname` gets translated into
+`:last_name`. If the `:from` option is set to an object that
+`respond_to?(:call)`, the object will be called and passed the attributes hash.
+
+```ruby
+class Person
+  include Virtus.model
+  include Virtus::Mapper
+
+  attribute :first_name, String
+  attribute :last_name, String, from: :surname
+  attribute :address,
+            String,
+            default: '',
+            from: lambda { |atts| atts[:address][:street] rescue '' }
+end
+
+person = Person.new({ first_name: 'John',
+                      surname: 'Doe',
+                      address: { 'street' => '1122 Boogie Avenue' } })
+person.first_name # => 'John'
+person.last_name # => 'Doe'
+person.address # => '1122 Boogie Avenue'
+person.surname # => NoMethodError
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/virtus-mapper/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+begin # don't puke if rspec isn't available
+  require 'rspec/core/rake_task'
+
+  desc 'Run specs'
+  RSpec::Core::RakeTask.new(:spec) do |r|
+    r.verbose = false
+    r.rspec_opts = '-t ~integration'
+  end
+
+rescue LoadError
+end
+
+

data/lib/virtus/mapper.rb

@@ -0,0 +1,46 @@
+require 'virtus/mapper/version'
+require 'virtus'
+require 'active_support/core_ext/hash/indifferent_access'
+
+HWIA = ActiveSupport::HashWithIndifferentAccess
+
+module Virtus
+  module Mapper
+
+    def initialize(attrs)
+      super(map_attributes!(HWIA.new(attrs)))
+    end
+
+    private
+
+    def map_attributes!(attrs)
+      attrs.tap do |h|
+        attributes_to_map_by_symbol(attrs).each do |att|
+          h[att.name] = h.delete(from(att))
+        end
+        attributes_to_map_by_call.each do |att|
+          h[att.name] = from(att).call(h)
+        end
+      end
+    end
+
+    def attributes_to_map_by_symbol(attrs)
+      attributes_to_map.select do |att|
+        !from(att).respond_to?(:call) &&
+        !attrs.has_key?(att.name)
+      end
+    end
+
+    def attributes_to_map_by_call
+      attributes_to_map.select { |att| from(att).respond_to?(:call) }
+    end
+
+    def attributes_to_map
+      attribute_set.select { |att| !(from(att).nil?) }
+    end
+
+    def from(attribute)
+      attribute.options[:from]
+    end
+  end
+end

data/lib/virtus/mapper/version.rb

@@ -0,0 +1,5 @@
+module Virtus
+  module Mapper
+    VERSION = "0.1.1"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/virtus/mapper_spec.rb

@@ -0,0 +1,83 @@
+require 'virtus'
+require 'virtus/mapper'
+
+module Virtus
+  RSpec.describe Mapper do
+
+    before do
+      module Examples
+        class Person
+          include Virtus.model
+          include Virtus::Mapper
+
+          attribute :id, Integer, from: :person_id, strict: true, required: true
+          attribute :first_name, String
+          attribute :last_name, String, from: :surname
+          attribute :address,
+                    String,
+                    default: '',
+                    from: lambda { |atts| atts[:address][:street] rescue '' }
+        end
+      end
+    end
+
+    let(:person_id) { 1 }
+    let(:first_name) { 'John' }
+    let(:last_name) { 'Doe' }
+    let(:address) { '1122 Something Avenue' }
+    let(:attrs) {
+      { person_id: person_id,
+        first_name: first_name,
+        surname: last_name,
+        address: { 'street' => address } }
+    }
+    let(:mapper) { Examples::Person.new(attrs) }
+
+    describe 'attribute with from option as symbol' do
+      it 'translates key' do
+        expect(mapper.last_name).to eq(last_name)
+      end
+
+      it 'does not create method from original key' do
+        expect { mapper.surname }.to raise_error(NoMethodError)
+      end
+
+      describe 'with attribute name as key' do
+        it 'does not raise error' do
+          expect { Examples::Person.new({id: 1}) }.not_to raise_error
+        end
+
+        it 'returns expected value' do
+          expect(Examples::Person.new({id: 1}).id).to eq(1)
+        end
+      end
+    end
+
+    describe 'attribute with from option as callable object' do
+      it 'calls the object and passes the attributes hash' do
+        callable = Examples::Person.attribute_set[:address].options[:from]
+        expect(callable).to receive(:call) { attrs }
+        Examples::Person.new(attrs)
+      end
+
+      it 'sets attribute to result of call' do
+        expect(mapper.address).to eq(address)
+      end
+    end
+
+
+    describe 'attribute without from option' do
+      it 'behaves as usual' do
+        expect(mapper.first_name).to eq(first_name)
+      end
+    end
+
+    it 'maps attributes with indifferent access' do
+      mapper = Examples::Person.new({ person_id: 1,
+                                      first_name: first_name,
+                                      'surname' => last_name })
+      expect(mapper.last_name).to eq('Doe')
+    end
+
+  end
+end

data/virtus-mapper.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'virtus/mapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "virtus-mapper"
+  spec.version       = Virtus::Mapper::VERSION
+  spec.authors       = ["RentPath"]
+  spec.email         = ["tstankus@rentpath.com", "tcampbell@rentpath.com"]
+  spec.summary       = %q{Mapper for Virtus attributes}
+  spec.description   = %q{Mapper for Virtus attributes. See README.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'virtus', '~> 1.0', '>= 1.0.3'
+  spec.add_runtime_dependency 'activesupport', '~> 4.1', '>= 4.1.6'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: virtus-mapper
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- RentPath
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Mapper for Virtus attributes. See README.
+email:
+- tstankus@rentpath.com
+- tcampbell@rentpath.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/virtus/mapper.rb
+- lib/virtus/mapper/version.rb
+- spec/spec_helper.rb
+- spec/virtus/mapper_spec.rb
+- virtus-mapper.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Mapper for Virtus attributes
+test_files:
+- spec/spec_helper.rb
+- spec/virtus/mapper_spec.rb