transpose 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b2601a6d33b837fc69ec9764b847ad6e7aa4aa4
+  data.tar.gz: 022b4fe46a3e0dd0be6bb2bcfe93a170d881a65d
+SHA512:
+  metadata.gz: c7626871423ec00f4fdfc8ddf2673961884f1e0a8d1ead94475e1493aaf82ec47ab824e756f4143decfee4710531e5f4463779de45997996c6bc847a85371a2d
+  data.tar.gz: b626a32e349649b1f8a79ea975864e6538cb4f7fe5f47547dfc2fdd2746cab1dc1facf5479ed77e57f113d57ff44d46c00da914f3a306e216d1f1bad02e38bc2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in transpose.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,39 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :bundler do
+  watch('Gemfile')
+  # Uncomment next line if your Gemfile contains the `gemspec' command.
+  # watch(/^.+\.gemspec/)
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch('spec/rails_helper.rb')                       { "spec" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jason Ayre
+
+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,87 @@
+# Transpose
+Simple object transpositions using hash map of attributes. Particularly useful when working with remote apis,
+and mapping from a remote structure, to a localized structure.
+
+### Example
+
+You want to map a remote post model with mostly camel cased method names, to a local active record model.
+
+``` ruby
+class RemotePost < ::OpenStruct
+  include ::Transpose::Transposable
+
+  transposer "Post", {
+    :Id => :remote_id,
+    :Title => :title,
+  }
+end
+```
+
+And back again
+
+``` ruby
+class Post < ::ActiveRecord::Base
+  include ::Transpose::Transposable
+
+  transposer "RemotePost", {
+    :remote_id => :Id,
+    :title => :Title
+  }
+end
+```
+
+So you do
+
+``` ruby
+remote = ::RemotePost.new(:Id => '1234', :Title => "Nocturne In e Flat Op 9 No.2" )
+local = remote.transpose(Post).save
+#=> #<Post id="1234", title="Nocturne In e Flat Op 9 No.2">
+```
+
+### Transposing already initialized instances
+
+Supports passing an instance as well via transpose_instance
+
+``` ruby
+post = Post.new(:title => "prebuilt title")
+remote_post = ::RemotePost.new(:Id => 1234)
+remote_post.transpose_instance(post)
+#=> #<Post id="1234", title="prebuilt title">
+```
+
+### Roadmap
+1. Implementing a good solution for working with external api gems, when classes
+have already been defined. I.E. abstracting injecting the transposer into remote model.
+
+2. **Maybe** support for getter and setter value strategies, i.e. right now you
+cant map an object to a hash, since it sets/gets via send.
+However, Im not sure that should be a concern of this gem, as that would likely
+kill much of the simplicity which Id like to keep.
+
+3. **Maybe** coercion of attributes via passing lambda as value
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'transpose'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transpose
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/transpose/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/transpose.rb

@@ -0,0 +1,14 @@
+require "transpose/version"
+#overkill?, maybe. But including primarily due to the
+#dependency management portion of concerns, i.e.
+#when manually defining extended method old fashioned way,
+#things have potential for getting fubar,
+#if you try to include Transposable into a concern
+
+require "active_support/all"
+require 'transpose/errors'
+require 'transpose/transposable'
+
+module Transpose
+
+end

data/lib/transpose/errors.rb

@@ -0,0 +1,5 @@
+module Transpose
+  module Errors
+    class TransposerNotFound < StandardError; end
+  end
+end

data/lib/transpose/transposable.rb

@@ -0,0 +1,45 @@
+module Transpose
+  module Transposable
+    extend ::ActiveSupport::Concern
+
+    included do
+      class_attribute :transposers
+
+      self.transposers = {}
+    end
+
+    module ClassMethods
+      def transposer(klass, attribute_map = {})
+        self.transposers[klass] = attribute_map
+      end
+    end
+
+    def transpose(klass)
+      transposition_instance = klass.is_a?(String) ? klass.constantize.new : klass.new
+
+      raise ::Transpose::Errors::TransposerNotFound unless self.class.transposers.has_key?(transposition_instance.class.name)
+
+      result = self.class.transposers[klass.to_s].inject(transposition_instance) do |transposition, hash_pair|
+        transposition.__send__("#{hash_pair[1]}=", self.__send__(hash_pair[0]))
+        transposition
+      end
+
+      result
+    end
+    alias :transpose_to :transpose
+    alias :transpose_into :transpose
+
+    def transpose_instance(transposition_instance)
+      raise ::Transpose::TransposerNotFound unless self.class.transposers.has_key?(transposition_instance.class.name)
+
+      result = self.class.transposers[transposition_instance.class.name].inject(transposition_instance) do |transposition, hash_pair|
+        transposition.__send__("#{hash_pair[1]}=", self.__send__(hash_pair[0]))
+        transposition
+      end
+
+      result
+    end
+    alias :transpose_to_instance :transpose_instance
+    alias :transpose_with_instance :transpose_instance
+  end
+end

data/lib/transpose/version.rb

@@ -0,0 +1,3 @@
+module Transpose
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+require 'simplecov'
+require 'pry'
+require 'transpose'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+  end
+end
+
+Bundler.require(:default, :development, :test)
+
+::Dir["#{::File.dirname(__FILE__)}/support/*.rb"].each {|f| require f }

data/spec/support/post.rb

@@ -0,0 +1,8 @@
+class Post < ::OpenStruct
+  include ::Transpose::Transposable
+
+  transposer "RemotePost", {
+    :id => :Id,
+    :title => :Title
+  }
+end

data/spec/support/remote_post.rb

@@ -0,0 +1,8 @@
+class RemotePost < ::OpenStruct
+  include ::Transpose::Transposable
+
+  transposer "Post", {
+    :Id => :id,
+    :Title => :title
+  }
+end

data/spec/transpose/transposable_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'support/remote_post'
+require 'support/post'
+
+describe ::Transpose::Transposable do
+  let(:id_value) { "1234" }
+  let(:title_value) { "Nocturne In e Flat Op 9 No.2"}
+  subject { ::RemotePost.new(:Id => id_value, :Title => title_value) }
+
+  describe "#transpose" do
+    context "RemotePost to Post" do
+      let(:transposition) { subject.transpose_to(::Post) }
+
+      it { transposition.id.should eq id_value }
+      it { transposition.title.should eq title_value }
+      it { transposition.should be_a(Post) }
+
+      context "Back to remote post" do
+        let(:retransposition) { transposition.transpose_to(::RemotePost) }
+
+        it { retransposition.Id.should eq id_value }
+        it { retransposition.Title.should eq title_value }
+        it { retransposition.should be_a(RemotePost) }
+      end
+    end
+
+    context "transposer does not exist" do
+      it "raises error" do
+        expect{ subject.transpose_to(Hash) }.to raise_error(Transpose::Errors::TransposerNotFound)
+      end
+    end
+  end
+
+  describe "#transpose_instance" do
+    let(:post) { ::Post.new(:category => 'cat1234') }
+    let(:transposition) { subject.transpose_instance(post) }
+
+    context "RemotePost to post" do
+      it { transposition.id.should eq id_value }
+      it { transposition.category.should eq 'cat1234' }
+    end
+  end
+
+  describe ".transposer" do
+    before do
+      subject.class.transposer "OpenStruct", {
+        :Id => :id,
+        :Title => :title
+      }
+    end
+
+    it { subject.class.transposers.should have_key("OpenStruct") }
+  end
+end

data/transpose.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transpose/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transpose"
+  spec.version       = Transpose::VERSION
+  spec.authors       = ["Jason Ayre"]
+  spec.email         = ["jasonayre@gmail.com"]
+  spec.summary       = %q{Transpose (or transform) one object into another}
+  spec.description   = %q{Object transformation via simple hash mapping of attributes. Great for transforming remote api objects into local models and vice versa}
+  spec.homepage      = "http://github.com/jasonayre/transpose"
+  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_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-pride"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency 'rspec-its', '~> 1'
+  spec.add_development_dependency 'rspec-collection_matchers', '~> 1'
+  spec.add_development_dependency 'guard', '~> 2'
+  spec.add_development_dependency 'guard-rspec', '~> 4'
+  spec.add_development_dependency 'guard-bundler', '~> 2'
+  spec.add_development_dependency 'rb-fsevent'
+  spec.add_development_dependency 'terminal-notifier-guard'
+end

metadata

@@ -0,0 +1,261 @@
+--- !ruby/object:Gem::Specification
+name: transpose
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jason Ayre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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-pride
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  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: terminal-notifier-guard
+  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: Object transformation via simple hash mapping of attributes. Great for
+  transforming remote api objects into local models and vice versa
+email:
+- jasonayre@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/transpose.rb
+- lib/transpose/errors.rb
+- lib/transpose/transposable.rb
+- lib/transpose/version.rb
+- spec/spec_helper.rb
+- spec/support/post.rb
+- spec/support/remote_post.rb
+- spec/transpose/transposable_spec.rb
+- transpose.gemspec
+homepage: http://github.com/jasonayre/transpose
+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: Transpose (or transform) one object into another
+test_files:
+- spec/spec_helper.rb
+- spec/support/post.rb
+- spec/support/remote_post.rb
+- spec/transpose/transposable_spec.rb