mapped_attributes 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+.idea/
+*.log
+*.swp
+*.gem
+Gemfile.lock
+.rvmrc

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Tomasz Borowski <http://tbprojects.pl> @TomaszBorowski
+
+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,82 @@
+Mapped Attributes
+=================
+
+This gem allows to build ActiveRecord objects with alternative attribute naming. It is useful when you are importing ie. fetched data from XLS or parsed data from some website.
+
+## Installation:
+```gem install mapped_attributes```
+
+or
+
+```gem 'mapped_attributes'``` in your Gemfile
+
+## Usage & Example
+Include **MappedAttributes** module to model, for which you would like to use attribute mapping:
+```ruby
+class Project < ActiveRecord::Base
+  include MappedAttributes
+
+  has_many :tasks
+  has_one :main_task, class_name: 'Task', order: 'priority ASC'
+  accepts_nested_attributes_for :main_task
+end
+
+class Task < ActiveRecord::Base
+  belongs_to :project
+end
+```
+
+Define attributes mapping for certain model in your locales:
+```yml
+en:
+  activerecord:
+    mappings:
+      project:
+        subject: Project Name
+        summary: Description
+        priority: Importance
+        start_at: 
+          - Beginning
+          - Start
+        main_task_attributes:
+          name: 
+            - Task Name
+            - Main Task
+          description: Info
+          due_date: Deadline
+```
+
+And finally set mapped attributes:
+```ruby
+    data = {
+        'Project Name'  => 'Testing One',
+        'Description'   => 'This project is just for test',
+        'Importance'    => '3',
+        'Beginning'     => '2013-01-01',
+        'Task Name'     => 'Get a Job Done',
+        'Info'          => 'Finalize first task',
+        'Deadline'      => '2013-02-01'
+        'Comments'      => 'Something something dark side'
+    }
+    project = Project.new
+    project.set_mapped_attributes(data)
+    project.save    
+```
+
+Also, you can list unmapped attributes:
+```ruby
+  project.get_unmapped_attributes
+  # => ['Comments']
+```
+
+## Features
+- you can map given data to object attributes
+- you can provide custom mapping definition namespace: ```project.set_mapped_attributes(data, as: :custom_project)```
+- you can define multiple mapping for a single attribute
+- you can map attributes for the *has_one* and *belongs_to* relations if you are using *nested_attributes*
+
+## Tests
+Module is tested with minitest. To run it just execute ```rake```
+
+## Credits
+[Tomasz Borowski](http://tbprojects.pl)

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/mapped_attributes'
+  t.test_files = FileList['test/lib/mapped_attributes/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/mapped_attributes.rb

@@ -0,0 +1,34 @@
+require_relative "mapped_attributes/version"
+
+module MappedAttributes
+  def set_mapped_attributes(data, opts = {})
+    @unused_data_fields = data.keys
+    mapping = get_attributes_mapping(opts[:as] || self.class.name.underscore)
+    self.attributes = get_mapped_attributes(data, mapping)
+  end
+
+  def get_unmapped_attributes
+    @unused_data_fields || []
+  end
+
+  private
+  def get_attributes_mapping(namespace)
+    mapping = I18n.t(namespace, scope: 'activerecord.mappings')
+    raise 'Mapping not defined in activerecord.mappings' unless mapping.is_a? Hash
+    mapping
+  end
+
+  def get_mapped_attributes(data, mapping)
+    mapping.inject({}) do |result, mapped_field|
+      if mapped_field[1].is_a? Hash
+        result[mapped_field[0]] = get_mapped_attributes(data, mapped_field[1])
+      else
+        labels = Array(mapped_field[1]).map(&:downcase)
+        @unused_data_fields.delete_if{|field| labels.include?(field.downcase)}
+        mapped_data = data.detect{|k,v| labels.include?(k.downcase)}
+        result[mapped_field[0]] = mapped_data[1] if mapped_data
+      end
+      result
+    end
+  end
+end

data/lib/mapped_attributes/version.rb

@@ -0,0 +1,3 @@
+module MappedAttributes
+  VERSION = "1.0.0"
+end

data/mapped_attributes.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mapped_attributes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mapped_attributes"
+  gem.version       = MappedAttributes::VERSION
+  gem.authors       = ["Tomasz Borowski [tbprojects]"]
+  gem.email         = 'info.tbprojects@gmail.com'
+  gem.description   = "Allows to build ActiveRecord objects with alternative attribute naming"
+  gem.summary       = "Allows to build ActiveRecord objects with alternative attribute naming"
+  gem.homepage      = "https://github.com/tbprojects/mapped_attributes"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rails'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_dependency 'activerecord'
+  gem.add_dependency 'i18n'
+end

data/test/lib/mapped_attributes/mapped_attributes_test.rb

@@ -0,0 +1,92 @@
+require_relative '../../test_helper'
+
+describe MappedAttributes do
+
+  it "responds to set_mapped_attributes" do
+    Project.new.respond_to?(:set_mapped_attributes).must_equal true
+  end
+
+  it "responds to get_unmapped_attributes" do
+    Project.new.respond_to?(:get_unmapped_attributes).must_equal true
+  end
+
+  it "sets and returns mapped attributes" do
+    data = {
+        'Project Name'  => 'Testing One',
+        'Description'   => 'This project is just for test',
+        'Importance'    => '3',
+        'Beginning'     => '2013-01-01',
+        'Task Name'     => 'Get a Job Done',
+        'Info'          => 'Finalize first task',
+        'Deadline'      => '2013-02-01'
+    }
+    project = Project.new
+    project.set_mapped_attributes(data)
+    project.save
+    project.persisted?.must_equal true
+    project.subject.must_equal data['Project Name']
+    project.summary.must_equal data['Description']
+    project.priority.to_s.must_equal data['Importance']
+    project.start_at.to_s(:db).must_equal data['Beginning']
+
+    task = project.main_task
+    task.persisted?.must_equal true
+    task.name.must_equal data['Task Name']
+    task.description.must_equal data['Info']
+    task.due_date.to_s(:db).must_equal data['Deadline']
+  end
+
+  it "remembers unmapped attributes" do
+    data = {
+        'Project Name'  => 'Testing One',
+        'Task Name'     => 'Get a Job Done',
+        'Comments'      => 'Additional Text'
+    }
+    project = Project.new
+    project.set_mapped_attributes(data)
+    project.save
+    project.persisted?.must_equal true
+    project.get_unmapped_attributes.must_equal ['Comments']
+  end
+
+  it "allows to give provide custom mapping namespace" do
+    data = {
+        'Project Label' => 'Testing One',
+        'Main Task'     => 'Get a Job Done',
+    }
+    project = Project.new
+    project.set_mapped_attributes(data, as: :custom_project)
+    project.save
+    project.persisted?.must_equal true
+    project.subject.must_equal data['Project Label']
+
+    task = project.main_task
+    task.persisted?.must_equal true
+    task.name.must_equal data['Main Task']
+  end
+
+  it 'allows to define multiple mappings for single attribute' do
+    data = {
+        'Work Name'     => 'Testing One',
+        'Subwork Name'  => 'Get a Job Done',
+    }
+    project = Project.new
+    project.set_mapped_attributes(data, as: :multiple_mapping_project)
+    project.save
+    project.persisted?.must_equal true
+    project.subject.must_equal data['Work Name']
+
+    task = project.main_task
+    task.persisted?.must_equal true
+    task.name.must_equal data['Subwork Name']
+  end
+
+  it "raises error when mapping is not defined" do
+    data = {
+        'Project Name'  => 'Testing One',
+        'Task Name'     => 'Get a Job Done'
+    }
+    project = Project.new
+    proc {project.set_mapped_attributes(data, as: :not_existing_mapping)}.must_raise RuntimeError
+  end
+end

data/test/lib/mapped_attributes/version_test.rb

@@ -0,0 +1,9 @@
+require_relative '../../test_helper'
+
+describe MappedAttributes do
+
+  it "version must be defined" do
+    MappedAttributes::VERSION.wont_be_nil
+  end
+
+end

data/test/rails_app/config/application.rb

@@ -0,0 +1,5 @@
+module RailsApp
+  class Application < Rails::Application
+    config.root = File.expand_path('../../', __FILE__)
+  end
+end

data/test/rails_app/config/database.yml

@@ -0,0 +1,24 @@
+sqlite3mem: &SQLITE3MEM
+  adapter: sqlite3
+  database: ":memory:"
+
+sqlite3: &SQLITE
+  adapter: sqlite3
+  database: mapped_attributes_test.sqlite3.db
+
+postgresql: &POSTGRES
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: mapped_attributes_test
+  min_messages: ERROR
+
+mysql: &MYSQL
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  database: mapped_attributes_test
+
+test:
+  <<: *<%= ENV['DB'] || 'SQLITE3MEM' %>

data/test/rails_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+RailsApp::Application.initialize!

data/test/rails_app/config/environments/development.rb

@@ -0,0 +1,19 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+end

data/test/rails_app/config/environments/production.rb

@@ -0,0 +1,33 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+end

data/test/rails_app/config/environments/test.rb

@@ -0,0 +1,33 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  config.action_dispatch.show_exceptions = false
+
+  config.active_support.deprecation = :stderr
+end

data/test/rails_app/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+Rails.backtrace_cleaner.remove_silencers!

data/test/rails_app/config/initializers/inflections.rb

@@ -0,0 +1,2 @@
+ActiveSupport::Inflector.inflections do |inflect|
+end

data/test/rails_app/config/initializers/secret_token.rb

@@ -0,0 +1,2 @@
+Rails.application.config.secret_token = 'ea942c41850d502f2c8283e26bdc57829f471bb18224ddff0a192c4f32cdf6cb5aa0d82b3a7a7adbeb640c4b06f3aa1cd5f098162d8240f669b39d6b49680571'
+Rails.application.config.session_store :cookie_store, :key => "_my_app"

data/test/rails_app/config/locales/en.yml

@@ -0,0 +1,24 @@
+en:
+  activerecord:
+    mappings:
+      project:
+        subject: Project Name
+        summary: Description
+        priority: Importance
+        start_at: Beginning
+        main_task_attributes:
+          name: Task Name
+          description: Info
+          due_date: Deadline
+      custom_project:
+        subject: Project Label
+        main_task_attributes:
+                  name: Main Task
+      multiple_mapping_project:
+        subject:
+          - Project Name
+          - Work Name
+        main_task_attributes:
+          name:
+            - Task Name
+            - Subwork Name

data/test/rails_app/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  match ':controller(/:action(/:id(.:format)))'
+end

data/test/support/models.rb

@@ -0,0 +1,16 @@
+class Project < ActiveRecord::Base
+
+  include MappedAttributes
+
+  has_many :tasks
+  has_one :main_task, class_name: 'Task', order: 'priority ASC'
+  accepts_nested_attributes_for :main_task
+
+  validates_presence_of :subject
+end
+
+class Task < ActiveRecord::Base
+  belongs_to :project
+
+  validates_presence_of :name
+end

data/test/support/schema.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+require 'logger'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+ActiveRecord::Base.logger = Logger.new(SPEC_ROOT.join('debug.log'))
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :projects, :force => true do |t|
+    t.column :subject, :string
+    t.column :summary, :text
+    t.column :priority, :integer
+    t.column :start_at, :date
+  end
+
+  create_table :tasks, :force => true do |t|
+    t.column :name, :string
+    t.column :description, :text
+    t.column :project_id, :integer
+    t.column :due_date, :date
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+ENV['RAILS_ENV'] = 'test'
+
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'rails/all'
+require File.expand_path('../rails_app/config/environment.rb', __FILE__)
+
+SPEC_ROOT = Pathname.new(File.expand_path('../', __FILE__))
+Dir[SPEC_ROOT.join('support/*.rb')].each{|f| require f }
+
+require File.expand_path('../../lib/mapped_attributes.rb', __FILE__)

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: mapped_attributes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tomasz Borowski [tbprojects]
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows to build ActiveRecord objects with alternative attribute naming
+email: info.tbprojects@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- lib/mapped_attributes.rb
+- lib/mapped_attributes/version.rb
+- mapped_attributes.gemspec
+- test/lib/mapped_attributes/mapped_attributes_test.rb
+- test/lib/mapped_attributes/version_test.rb
+- test/rails_app/config/application.rb
+- test/rails_app/config/database.yml
+- test/rails_app/config/environment.rb
+- test/rails_app/config/environments/development.rb
+- test/rails_app/config/environments/production.rb
+- test/rails_app/config/environments/test.rb
+- test/rails_app/config/initializers/backtrace_silencers.rb
+- test/rails_app/config/initializers/inflections.rb
+- test/rails_app/config/initializers/secret_token.rb
+- test/rails_app/config/locales/en.yml
+- test/rails_app/config/routes.rb
+- test/support/models.rb
+- test/support/schema.rb
+- test/test_helper.rb
+homepage: https://github.com/tbprojects/mapped_attributes
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Allows to build ActiveRecord objects with alternative attribute naming
+test_files: []