serialize_virtual_attributes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46531c23ca6e85014e42461dcc33f17bf8a3e9e4
+  data.tar.gz: cf1ef697be33b5c5b2944b59f0d14fca30c14068
+SHA512:
+  metadata.gz: a30fe8b26645dcbeab8d84032016ae732e6d9c98259317c83c1dd959c65dbcb913939852ab1d672f9903289b101893b564dbe740bd31c3e1412ebde662e10538
+  data.tar.gz: 50819e5f0dbfb3fe48728c1ce1276acc2bbb325862681a7c7e4a1da409f79472d2853d129510a5613105f0bd728990a26e48d4df6cfb73a70af6c39a0b969874

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+spec/test.sqlite3

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    serialize_virtual_attributes (0.0.1)
+      activerecord (~> 3.1)
+      activesupport (~> 3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.18)
+      activesupport (= 3.2.18)
+      builder (~> 3.0.0)
+    activerecord (3.2.18)
+      activemodel (= 3.2.18)
+      activesupport (= 3.2.18)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.18)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    byebug (3.1.2)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    columnize (0.8.9)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.5)
+    guard (2.6.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.2.9)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    i18n (0.6.9)
+    listen (2.7.6)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.6)
+    method_source (0.8.2)
+    multi_json (1.10.1)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.4)
+      ffi (>= 0.5.0)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
+    slop (3.5.0)
+    sqlite3 (1.3.9)
+    terminal-notifier-guard (1.5.3)
+    thor (0.19.1)
+    timers (1.1.0)
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  byebug
+  guard-rspec
+  rake
+  rspec
+  serialize_virtual_attributes!
+  sqlite3
+  terminal-notifier-guard

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :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" }
+
+  # 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 Hao Liu
+
+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,42 @@
+# SerializeVirtualAttributes
+
+Dump/Reload the specified virtual attributes into/from serialized column
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'serialize_virtual_attributes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serialize_virtual_attributes
+
+## Usage
+
+```ruby
+class Person < ActiveRecord::Base
+  serialize :fullname, Hash
+
+  serialize_virtual_attrs :first_name, :last_name, to: fullname
+end
+
+person = Person.create(first_name: "Hao", last_name: "Liu")
+
+person.reload
+
+person.first_name # "Hao"
+person.last_name # "Liu"
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/serialize_virtual_attributes.rb

@@ -0,0 +1,46 @@
+require "active_support"
+require "active_record"
+
+require "serialize_virtual_attributes/version"
+
+module SerializeVirtualAttributes
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def serialize_virtual_attrs(*attrs, opts)
+      if attrs.nil? or (attrs.compact! and attrs.empty?)
+        raise ArgumentError.new("No virtual attributes provided")
+      end
+
+      to = HashWithIndifferentAccess.new(opts).fetch(:to) rescue nil
+
+      if to.blank?
+        raise ArgumentError.new("No serialized column provided")
+      end
+
+      if self.column_names.index(to.to_s).nil?
+        raise ArgumentError.new("`#{to}` is not a valid column of table `#{self.table_name}`")
+      end
+
+      attrs.each do |attr|
+        if self.column_names.index(attr.to_s).present?
+          raise ArgumentError.new("`#{attr}` is not supposed to be a virtual attribute")
+        end
+
+        if !self.accessible_attributes.include?(attr)
+          self.accessible_attributes << attr
+        end
+
+        define_method "#{attr}=" do |val|
+          self.public_send(to).send('[]=', attr, val)
+        end
+
+        define_method attr do
+          self.public_send(to).send('[]', attr)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, SerializeVirtualAttributes)

data/lib/serialize_virtual_attributes/version.rb

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

data/serialize_virtual_attributes.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serialize_virtual_attributes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "serialize_virtual_attributes"
+  spec.version       = SerializeVirtualAttributes::VERSION
+  spec.authors       = ["Hao Liu"]
+  spec.email         = ["leomayleomay@gmail.com"]
+  spec.description   = %q{virtual attributes accessor via a serialized Hash column}
+  spec.summary       = %q{Serialize specified virtual attributes into a Hash column}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.1"
+  spec.add_dependency "activesupport", "~> 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "terminal-notifier-guard"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "byebug"
+end

data/spec/lib/serialize_virtual_attributes_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe SerializeVirtualAttributes do
+  describe ".serialize_virtual_attrs" do
+    it "raises error if no virtual attributes provided" do
+      expect do
+        class Person < ActiveRecord::Base
+          serialize_virtual_attrs nil, to: :fullname
+        end
+      end.to raise_error(
+        ArgumentError,
+        "No virtual attributes provided"
+      )
+    end
+
+    it "raises error the virtual attributes are not that virtual" do
+      expect do
+        class Person < ActiveRecord::Base
+          serialize_virtual_attrs :fullname, to: :fullname
+        end
+      end.to raise_error(
+        ArgumentError,
+        "`fullname` is not supposed to be a virtual attribute"
+      )
+    end
+
+    it "raises error if no destination provided" do
+      expect do
+        class Person < ActiveRecord::Base
+          serialize_virtual_attrs :first_name, :last_name, to: nil
+        end
+      end.to raise_error(
+        ArgumentError,
+        "No serialized column provided"
+      )
+    end
+
+    it "raises error if the destination is not a field of the object" do
+      expect do
+        class Person < ActiveRecord::Base
+          serialize_virtual_attrs :first_name, :last_name, to: :body
+        end
+      end.to raise_error(
+        ArgumentError,
+        "`body` is not a valid column of table `people`"
+      )
+    end
+
+    it "appends the virtual attributes to the attr_accessible" do
+      class Person < ActiveRecord::Base
+        serialize_virtual_attrs :first_name, :last_name, to: :fullname
+      end
+
+      expect(Person.accessible_attributes).to include(:first_name)
+      expect(Person.accessible_attributes).to include(:last_name)
+    end
+
+    it "saves the virtual attributes in the serialized column" do
+      class Person < ActiveRecord::Base
+        serialize :fullname, Hash
+        serialize_virtual_attrs :first_name, :last_name, to: :fullname
+      end
+
+      person = Person.new(first_name: "hao", last_name: "liu")
+
+      expect(person.fullname[:first_name]).to eq "hao"
+      expect(person.fullname[:last_name]).to eq "liu"
+    end
+
+    it "loads the virtual attributes from the serialized column" do
+      class Person < ActiveRecord::Base
+        serialize :fullname, Hash
+        serialize_virtual_attrs :first_name, :last_name, to: :fullname
+      end
+
+      person = Person.create(first_name: "hao", last_name: "liu")
+      person.reload
+
+      expect(person.first_name).to eq "hao"
+      expect(person.last_name).to eq "liu"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler/setup'
+
+require 'serialize_virtual_attributes'
+
+RSpec.configure do |config|
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html
+end
+
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: File.dirname(__FILE__) + "/test.sqlite3"
+)
+
+load File.dirname(__FILE__) + '/support/schema.rb'

data/spec/support/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :people, force: true do |t|
+    t.string :fullname
+
+    t.timestamps
+  end
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: serialize_virtual_attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hao Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: guard-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: 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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: virtual attributes accessor via a serialized Hash column
+email:
+- leomayleomay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/serialize_virtual_attributes.rb
+- lib/serialize_virtual_attributes/version.rb
+- serialize_virtual_attributes.gemspec
+- spec/lib/serialize_virtual_attributes_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.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: Serialize specified virtual attributes into a Hash column
+test_files:
+- spec/lib/serialize_virtual_attributes_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb