activerecord-attribute_converter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a1107bf795acf0d0ddd42afc3cd1512760445c4
+  data.tar.gz: f38eae4f2d62f732acddde5b5e096caf6228cda8
+SHA512:
+  metadata.gz: 44ae86c61702a4c4ca8204b56ccb07417943d1a645d1a3b263d7a3bc2cc48872a9b9e17d982d15a72785a7320d08e0dfadd591310df4abf5f6b58c822fd690a0
+  data.tar.gz: 413bc326e4a9eca90aa7dbd66be9d447deb6f967be959d2db40d5151ba77e5f0078bb585cbc62b18fc36de366587009e33233eaf1e87a5d8a1534cd9af50b076

data/.gitignore

@@ -0,0 +1,24 @@
+*.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
+gemfiles/*.gemfile.lock
+gemfiles/vendor/bundle

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - ruby-head
+gemfile:
+  - gemfiles/rails_3.2.gemfile
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Appraisals

@@ -0,0 +1,13 @@
+appraise 'rails-3.2' do
+  gem 'activerecord', '~> 3.2'
+end
+
+appraise 'rails-4.0' do
+  gem 'activerecord', '~> 4.0'
+end
+
+appraise 'rails-4.1' do
+  gem 'activerecord', '~> 4.1.0.rc1'
+end
+
+# vim: set ft=ruby:

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 2014-03-17
+- Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kohei Suzuki
+
+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,75 @@
+# ActiveRecord::AttributeConverter
+[![Build Status](https://api.travis-ci.org/eagletmt/activerecord-attribute_converter.png?branch=master)](https://travis-ci.org/eagletmt/activerecord-attribute_converter)
+
+Transparent conversion for ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-attribute_converter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-attribute_converter
+
+## Usage
+
+```ruby
+class Plus
+  def initialize(x)
+    @x = x
+  end
+
+  def internalize(n)
+    n+@x
+  end
+
+  def externalize(n)
+    n-@x
+  end
+end
+
+module Rot13
+  module_function
+
+  def internalize(str)
+    str.tr('A-Za-z', 'N-ZA-Mn-za-m')
+  end
+
+  def externalize(str)
+    internalize(str)
+  end
+end
+
+class Book < ActiveRecord::Base
+  apply_converter :page, Plus.new(10)
+  apply_converter :title, Rot13
+end
+```
+
+```ruby
+book = Book.create(author: 'Author', title: 'Title', page: 24)
+p book.author   # => "Author"
+p book.title    # => "Title"
+p book.page     # => 24
+
+in_db = Book.connection.execute('SELECT * FROM books').first
+p in_db['author']   # => "Author"
+p in_db['title']    # => "Gvgyr"
+p in_db['page']     # => 34
+
+p Book.where(title: 'Title').map(&:title)    # => ["Title"]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/eagletmt/activerecord-attribute_converter/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,30 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'appraisal'
+namespace :spec do
+  appraisals = Appraisal::File.each
+
+  desc 'bundle install to local directory'
+  task :bundle do
+    appraisals.each do |appraisal|
+      env = { 'BUNDLE_GEMFILE' => appraisal.gemfile_path }
+      Bundler.clean_system(env, 'bundle', 'install', '-j4', '--path', 'vendor/bundle')
+    end
+  end
+
+  desc 'Run RSpec for each appraisal'
+  task :all => appraisals.map(&:name)
+
+  appraisals.each do |appraisal|
+    desc "Run RSpec with appraisal #{appraisal.name}"
+    task appraisal.name do
+      env = { 'BUNDLE_GEMFILE' => appraisal.gemfile_path }
+      Bundler.clean_system(env, 'bundle', 'exec', 'rake', 'spec')
+    end
+  end
+end

data/activerecord-attribute_converter.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/attribute_converter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-attribute_converter"
+  spec.version       = ActiveRecord::AttributeConverter::VERSION
+  spec.authors       = ["Kohei Suzuki"]
+  spec.email         = ["eagletmt@gmail.com"]
+  spec.summary       = %q{Transparent conversion for ActiveRecord}
+  spec.description   = %q{Transparent conversion for ActiveRecord}
+  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_dependency "activerecord", ">= 3.2"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0.beta1"
+  spec.add_development_dependency "appraisal", "~> 1.0.0.beta1"
+
+  spec.add_development_dependency "sqlite3"
+end

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2"
+
+gemspec :path=>".././"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0"
+
+gemspec :path=>".././"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0.rc1"
+
+gemspec :path=>".././"

data/lib/activerecord/attribute_converter/base.rb

@@ -0,0 +1,48 @@
+module ActiveRecord
+  module AttributeConverter
+    module Base
+      extend ActiveSupport::Concern
+
+      def internalize_attributes
+        self.class.attribute_converters.each do |attr, converter|
+          if attributes.has_key?(attr)
+            send("#{attr}=", converter.internalize(send(attr)))
+          end
+        end
+      end
+
+      def externalize_attributes
+        self.class.attribute_converters.each do |attr, converter|
+          if attributes.has_key?(attr)
+            send("#{attr}=", converter.externalize(send(attr)))
+          end
+        end
+      end
+
+      module ClassMethods
+        def apply_converter(attr, converter)
+          unless @attribute_converters
+            install_attribute_converter
+          end
+
+          self.attribute_converters[attr.to_s] = converter
+        end
+
+        def install_attribute_converter
+          @attribute_converters = {}
+
+          before_save :internalize_attributes
+
+          after_save :externalize_attributes
+          after_find :externalize_attributes
+        end
+
+        def attribute_converters
+          @attribute_converters || {}
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveRecord::AttributeConverter::Base)

data/lib/activerecord/attribute_converter/predicate_builder.rb

@@ -0,0 +1,26 @@
+module ActiveRecord
+  module AttributeConverter
+    module PredicateBuilder
+      def build_from_hash_with_attribute_converter(*args)
+        klass = args[0]
+        unless klass.attribute_converters.empty?
+          attributes = args[1].stringify_keys
+
+          klass.attribute_converters.each do |attr, converter|
+            if attributes.has_key?(attr)
+              attributes[attr] = converter.internalize(attributes[attr])
+            end
+          end
+
+          args[1] = attributes
+        end
+        build_from_hash_without_attribute_converter(*args)
+      end
+    end
+  end
+end
+
+ActiveRecord::PredicateBuilder.singleton_class.class_eval do
+  include ActiveRecord::AttributeConverter::PredicateBuilder
+  alias_method_chain :build_from_hash, :attribute_converter
+end

data/lib/activerecord/attribute_converter/relation.rb

@@ -0,0 +1,28 @@
+module ActiveRecord
+  module AttributeConverter
+    module Relation
+      def update_all_with_attribute_converter(*args)
+        updates = args[0]
+        conditions = args[1]
+        options = args[2] || {}
+
+        if !conditions && !options.present? && !@klass.attribute_converters.empty? && updates.is_a?(Hash)
+          updates = updates.stringify_keys
+          @klass.attribute_converters.each do |attr, converter|
+            if updates.has_key?(attr)
+              updates[attr] = converter.internalize(updates[attr])
+            end
+          end
+          args[0] = updates
+        end
+
+        update_all_without_attribute_converter(*args)
+      end
+    end
+  end
+end
+
+ActiveRecord::Relation.class_eval do
+  include ActiveRecord::AttributeConverter::Relation
+  alias_method_chain :update_all, :attribute_converter
+end

data/lib/activerecord/attribute_converter/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module AttributeConverter
+    VERSION = "0.1.0"
+  end
+end

data/lib/activerecord/attribute_converter.rb

@@ -0,0 +1,8 @@
+require 'active_support/lazy_load_hooks'
+require 'activerecord/attribute_converter/version'
+
+ActiveSupport.on_load(:active_record) do
+  require 'activerecord/attribute_converter/base'
+  require 'activerecord/attribute_converter/relation'
+  require 'activerecord/attribute_converter/predicate_builder'
+end

data/spec/attribute_converter_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe ActiveRecord::AttributeConverter do
+  describe '#save' do
+    let(:book) { Book.new(author: 'Author', title: 'Title', page: 24) }
+
+    it 'converts attributes' do
+      expect(book.title).to eq('Title')
+      expect(book.page).to eq(24)
+      book.save
+      expect(book.title).to eq('Title')
+      expect(book.page).to eq(24)
+      expect(Book.where(['title = ?', 'Title'])).to_not exist
+    end
+  end
+
+  describe 'query methods' do
+    before do
+      Book.create(author: 'Author', title: 'Title', page: 24)
+    end
+
+    describe 'find_by_*' do
+      it 'finds record by external value' do
+        expect(Book.find_by_author('Author')).to_not be_nil
+        expect(Book.find_by_title('Title')).to_not be_nil
+        expect(Book.find_by_author_and_page('Author', 24)).to_not be_nil
+        expect(Book.find_by_title_and_page('Title', 24)).to_not be_nil
+      end
+    end
+
+    describe 'find_by', version: 4 do
+      it 'finds record by external value' do
+        expect(Book.find_by(author: 'Author')).to_not be_nil
+        expect(Book.find_by(title: 'Title')).to_not be_nil
+        expect(Book.find_by(author: 'Author', page: 24)).to_not be_nil
+        expect(Book.find_by(title: 'Title', page: 24)).to_not be_nil
+      end
+    end
+
+    describe 'where' do
+      it 'finds records by Hash' do
+        expect(Book.where(author: 'Author')).to exist
+        expect(Book.where(title: 'Title')).to exist
+        expect(Book.where(author: 'Author', page: 24)).to exist
+        expect(Book.where(title: 'Title', page: 24)).to exist
+      end
+
+      it "doesn't support String/Array finder" do
+        expect(Book.where(['author = ?', 'Author'])).to exist
+        expect(Book.where(['title = ?', 'Title'])).to_not exist
+        expect(Book.where(['page = ?', 24])).to_not exist
+        expect(Book.where('page = 24')).to_not exist
+      end
+    end
+  end
+
+  describe 'update methods' do
+    let!(:book) { Book.create(author: 'Author', title: 'Title', page: 24) }
+
+    describe 'update_column' do
+      it 'converts attributes' do
+        book.update_column(:title, 'New Title')
+        expect(book.title).to eq('New Title')
+        expect(Book.where(title: 'New Title')).to exist
+      end
+    end
+
+    describe 'update_all' do
+      it 'converts attributes by Hash' do
+        Book.where(author: 'Author').update_all(page: 100)
+        expect(book.reload.page).to eq(100)
+        expect(Book.where(page: 100)).to exist
+        expect(Book.where('page = ?', 100)).to_not exist
+      end
+
+      it "doesn't support String/Array" do
+        Book.where(author: 'Author').update_all(['page = ?', 100])
+        expect(book.reload.page).to_not eq(100)
+        expect(Book.where(page: 100)).to_not exist
+        expect(Book.where('page = ?', 100)).to exist
+      end
+    end
+  end
+end

data/spec/models.rb

@@ -0,0 +1,30 @@
+class Plus
+  def initialize(x)
+    @x = x
+  end
+
+  def internalize(n)
+    n+@x
+  end
+
+  def externalize(n)
+    n-@x
+  end
+end
+
+module Rot13
+  module_function
+
+  def internalize(str)
+    str.tr('A-Za-z', 'N-ZA-Mn-za-m')
+  end
+
+  def externalize(str)
+    internalize(str)
+  end
+end
+
+class Book < ActiveRecord::Base
+  apply_converter :page, Plus.new(10)
+  apply_converter :title, Rot13
+end

data/spec/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define(version: 0) do
+  create_table :books do |t|
+    t.string :title
+    t.string :author
+    t.integer :page
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'activerecord/attribute_converter'
+
+require 'active_record'
+ActiveRecord::Base.configurations['test'] = {
+  adapter: 'sqlite3',
+  database: ':memory:',
+}
+ActiveRecord::Base.establish_connection('test')
+require File.expand_path('../schema', __FILE__)
+require File.expand_path('../models', __FILE__)
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.filter_run_excluding version: lambda { |v| v != ActiveRecord::VERSION::MAJOR }
+  config.run_all_when_everything_filtered = true
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+
+  config.after :each do
+    Book.delete_all
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-attribute_converter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kohei Suzuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bundler
+  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: 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: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Transparent conversion for ActiveRecord
+email:
+- eagletmt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-attribute_converter.gemspec
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- lib/activerecord/attribute_converter.rb
+- lib/activerecord/attribute_converter/base.rb
+- lib/activerecord/attribute_converter/predicate_builder.rb
+- lib/activerecord/attribute_converter/relation.rb
+- lib/activerecord/attribute_converter/version.rb
+- spec/attribute_converter_spec.rb
+- spec/models.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+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: Transparent conversion for ActiveRecord
+test_files:
+- spec/attribute_converter_spec.rb
+- spec/models.rb
+- spec/schema.rb
+- spec/spec_helper.rb