acts_as_array 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 120a75d054520211cc914c9fd78ad4f1462fb23a
+  data.tar.gz: 8477ac317dacdd580e5d36ff6eea21c8b544ec90
+SHA512:
+  metadata.gz: a29c33a7618a5e1533e6b58a801ecda5e5cbe0289be94574e6a715eb2b1bb1f9172179f6b8b84be3c46bac64544b9ea7c5fd2866a7f67a1a9721cc7a149c6086
+  data.tar.gz: fa00f4b6bc2a105237c77d1b5c441e8973699eb423ba1e1fbede0eecf5e44a2cf2f50cd67187c629b492b878da2808cee1d22065b28a2743de83b24c6f03f1f4

data/.gitignore

@@ -0,0 +1,10 @@
+Gemfile.lock
+.bundle
+.yardoc
+*.rbc
+.rbx/
+doc/
+.DS_Store
+tags
+pkg/*
+*.db

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - rbx-2
+  - jruby-19mode
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+First version

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'coveralls', :require => false
+gem 'activerecord'
+gem 'sqlite3'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Naotoshi Seo
+
+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,140 @@
+# Acts as array
+
+`acts_as_array` makes possible to treat your array fields simply.
+
+[![Build Status](https://travis-ci.org/sonots/acts_as_array.svg)](https://travis-ci.org/sonots/acts_as_array)
+[![Coverage Status](https://coveralls.io/repos/sonots/acts_as_array/badge.png)](https://coveralls.io/r/sonots/acts_as_array)
+
+## Installation
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem 'acts_as_array'
+```
+
+And then execute:
+
+```plain
+$ bundle
+```
+
+## What is this for?
+
+Say an user has multiple mail addresses. Typically you will define table schema as:
+
+```ruby
+create_table :users do |t|
+  t.string :name
+end
+
+create_table :mails do |t|
+  t.string :address
+  t.references :user
+end
+```
+
+And, define ActiveRecord models as:
+
+```ruby
+class Mail < ActiveRecord::Base
+  belongs_to :user
+end
+
+class User < ActiveRecord::Base
+  has_many :mails
+end
+```
+
+In this case, you will store multiple mail addresses to an users like:
+
+```ruby
+ichiro = User.new(name: 'Ichiro')
+ichiro.mails = [Mail.new(address: 'ichiro@example.com'), Mail.new(address: 'ichiro2@example.com')]
+ichiro.save
+```
+
+But, you want to set multiple mail addresses simply like followings?:
+
+```ruby
+ichiro = User.new(name: 'Ichiro')
+ichiro.mails = ['ichiro@example.com', 'ichiro2@example.com']
+ichiro.save
+```
+
+Then, `acts_as_array` is available for you. 
+
+
+### With acts_as_array
+
+Use `acts_as_array` as:
+
+```ruby
+class Mail < ActiveRecord::Base
+  belongs_to :user
+end
+
+require 'acts_as_array'
+class User < ActiveRecord::Base
+  has_many :mails
+  include ActsAsArray
+  acts_as_array :mails => {:class => Mail, :field => :address} 
+end
+```
+
+Then, it makes possible to set and get non-object array values like:
+
+```ruby
+ichiro = User.new(name: 'Ichiro')
+ichiro.mails = ['ichiro@example.com', 'ichiro2@example.com']
+ichiro.save
+User.first.mails #=> ['ichiro@example.com', 'ichiro2@example.com']
+```
+
+You can also get the original object array values with:
+
+```ruby
+ichiro.obj_mails #=> [Mail.new(address: 'ichiro@example.com'), Mail.new(address: 'ichiro2@example.com')]
+```
+
+## Supported methods
+
+Following ActiveRecord methods are supported to specify non-object array values:
+
+* create
+
+  `create(field: non_object_array)`
+
+* update_attributes
+
+   `update_attributes(field: non_object_array)`
+
+* update
+
+   `update(field: non_object_array)`
+
+* {field}=
+
+   `{field} = non_object_array`
+
+Also, following getter methods are available:
+
+* {field}
+
+  Return non-object array values
+
+* obj_{field}
+
+  Return object array values
+
+## 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
+
+## Copyright
+
+* Copyright (c) 2014 Naotoshi Seo. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,19 @@
+# coding: utf-8
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ["-c", "-f progress"] # '--format specdoc'
+      t.pattern = 'spec/**/*_spec.rb'
+end
+task :test => :spec
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+  sh 'irb -rubygems -I lib -I spec -r acts_as_array -r spec_helper -r model'
+end
+task :c => :console
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/spec')
+require 'migrate_tasks'

data/acts_as_array.gemspec

@@ -0,0 +1,25 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name          = "acts_as_array"
+  s.authors       = ["Naotoshi Seo"]
+  s.email         = ["sonots@gmail.com"]
+  s.homepage      = "https://github.com/sonots/acts_as_array"
+  s.summary       = "Treat array fields simply"
+  s.description   = "Treat array fields simply."
+  s.version       = '0.0.1'
+  s.date          = Time.now.strftime("%Y-%m-%d")
+
+  s.extra_rdoc_files = Dir["*.rdoc"]
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.rdoc_options  = ["--charset=UTF-8"]
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-nav'
+end

data/db/migrate/001_create_users.rb

@@ -0,0 +1,13 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :name
+    end
+    add_index :users, :name, :unique => true
+  end
+ 
+  def self.down
+    drop_table :users
+  end
+end
+

data/db/migrate/002_create_mails.rb

@@ -0,0 +1,14 @@
+class CreateMails < ActiveRecord::Migration
+  def self.up
+    create_table :mails do |t|
+      t.string :name
+      t.references :user
+    end
+    add_index :mails, :name, :unique => true
+  end
+ 
+  def self.down
+    drop_table :mails
+  end
+end
+

data/db/migrate/003_create_phones.rb

@@ -0,0 +1,14 @@
+class CreatePhones < ActiveRecord::Migration
+  def self.up
+    create_table :phones do |t|
+      t.string :name
+      t.references :user
+    end
+    add_index :phones, :name, :unique => true
+  end
+ 
+  def self.down
+    drop_table :phones
+  end
+end
+

data/db/schema.rb

@@ -0,0 +1,35 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 3) do
+
+  create_table "mails", force: true do |t|
+    t.string  "name"
+    t.integer "user_id"
+  end
+
+  add_index "mails", ["name"], name: "index_mails_on_name", unique: true
+
+  create_table "phones", force: true do |t|
+    t.string  "name"
+    t.integer "user_id"
+  end
+
+  add_index "phones", ["name"], name: "index_phones_on_name", unique: true
+
+  create_table "users", force: true do |t|
+    t.string "name"
+  end
+
+  add_index "users", ["name"], name: "index_users_on_name", unique: true
+
+end

data/lib/acts_as_array.rb

@@ -0,0 +1,60 @@
+module ActsAsArray
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    # acts_as_array :has_many_field => {:class => Class, :field => :name}
+    def acts_as_array(params = {})
+      self.class_eval do
+        params.each do |field, opts|
+          # xxxx = raw_array #=> obj_array
+          #
+          # Example:
+          #
+          # mails = ['a@a.com', 'b@b.com']
+          #   #=> [Mail.new(name: 'a@a.com'), Mail.new(name: 'b@b.com')]
+          unless method_defined?("#{field}_with_arraymap=")
+            define_method("#{field}_with_arraymap=") do |raw_array|
+              obj_array = __send__("make_#{field}", raw_array)
+              __send__("#{field}_without_arraymap=", obj_array)
+            end
+            define_method("#{field}=") {|*args| } unless method_defined?("#{field}=")
+            alias_method("#{field}_without_arraymap=", "#{field}=")
+            alias_method("#{field}=", "#{field}_with_arraymap=")
+          end
+
+          # Example:
+          #
+          # mails_without_arraymap #=> [Mail.new(name: 'a@a.com'), Mail.new(name: 'b@b.com')]
+          # mails | mails_with_arraymap #=> ['a@a.com', 'b@b.com']
+          unless method_defined?("#{field}_with_arraymap")
+            define_method("#{field}_with_arraymap") do
+              obj_array = __send__("#{field}_without_arraymap")
+              obj_array.map {|obj| obj.__send__(opts[:field]) }
+            end
+            define_method("#{field}") { } unless method_defined?("#{field}")
+            alias_method("#{field}_without_arraymap", "#{field}")
+            alias_method("#{field}", "#{field}_with_arraymap")
+          end
+
+          # obj_mails #=> [Mail.new(name: 'a@a.com'), Mail.new(name: 'b@b.com')]
+          define_method("obj_#{field}") do
+            __send__("#{field}_without_arraymap")
+          end
+
+          # make_xxxx(raw_array) #=> obj_array
+          #
+          # Example:
+          #
+          # make_mails(['a@a.com', 'b@b.com'])
+          #   #=> [Mail.new(name: 'a@a.com'), Mail.new(name: 'b@b.com')]
+          define_method("make_#{field}") do |raw_array|
+            return nil unless raw_array
+            raw_array.map {|val| opts[:class].find_or_initialize_by(opts[:field] => val) }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/acts_as_array_spec.rb

@@ -0,0 +1,75 @@
+require_relative 'spec_helper'
+require_relative 'model'
+
+describe ActsAsArray do
+  after do
+    User.delete_all
+    Mail.delete_all
+    Phone.delete_all
+  end
+  let(:user) { User.new(name: 'test') }
+  let(:raw_mails) { ['a@a.com', 'b@b.com'] }
+
+  context '#make_fields' do
+    let(:subject) { user.make_mails(raw_mails) }
+    it 'should convert raw fields to obj fields' do
+      expect(subject.map(&:name)).to eql(raw_mails)
+      expect(Mail.all.size).to eql(0)
+    end
+  end
+
+  context '#fields=' do
+    before { user.mails = raw_mails }
+    it 'should set raw fields as obj fields' do
+      expect(user.obj_mails.map(&:name)).to eql(raw_mails)
+      expect(Mail.all.size).to eql(0)
+    end
+
+    it 'should create objects with #save' do
+      user.save
+      expect(Mail.all.size).to eql(2)
+    end
+
+    it 'should not create already existing objects' do
+      user.save
+      user.mails = raw_mails
+      expect(Mail.all.size).to eql(2)
+    end
+  end
+
+  context '#fields' do
+    before { user.mails = raw_mails }
+    it 'should return raw fields' do
+      expect(user.mails).to eql(raw_mails)
+    end
+  end
+
+  context '#obj_fields' do
+    before { user.mails = raw_mails }
+    it 'should return obj fields' do
+      expect(user.obj_mails.map(&:name)).to eql(raw_mails)
+    end
+  end
+
+  context '#update_attributes' do
+    it 'should update_attributes with raw fields' do
+      user.update_attributes(mails: raw_mails)
+      expect(user.obj_mails.map(&:name)).to eql(raw_mails)
+      expect(Mail.all.size).to eql(2)
+    end
+  end
+
+  context '#update' do
+    it 'should update with raw fields' do
+      user.update(mails: raw_mails)
+      expect(user.obj_mails.map(&:name)).to eql(raw_mails)
+      expect(Mail.all.size).to eql(2)
+    end
+  end
+
+  context '.create' do
+    let(:user) { User.create(name: 'test', mails: raw_mails) }
+    it { expect(user.obj_mails.map(&:name)).to eql(raw_mails) }
+  end
+end
+

data/spec/migrate_tasks.rb

@@ -0,0 +1,43 @@
+require 'active_record'
+require 'logger'
+ 
+namespace :db do
+  MIGRATIONS_DIR = 'db/migrate'
+  SCHEMA_FILE    = 'db/schema.rb'
+  DB_FILE        = 'db/sqlite.db'
+ 
+  # connect the database
+  ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database => DB_FILE
+  )
+ 
+  # outpt logs
+  # ActiveRecord::Base.logger = Logger.new(STDOUT)
+ 
+  desc "Migrate the database"
+  task :migrate do
+    ActiveRecord::Migrator.migrate(MIGRATIONS_DIR, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+  end
+ 
+  desc 'Roll back the database schema to the previous version'
+  task :rollback do
+    ActiveRecord::Migrator.rollback(MIGRATIONS_DIR, ENV['STEP'] ? ENV['STEP'].to_i : 1)
+  end
+
+  namespace :schema do
+    desc "Create a db/schema.rb file that can be portably used against any DB supported by AR"
+    task :dump do
+      require 'active_record/schema_dumper'
+      File.open(ENV['SCHEMA'] || SCHEMA_FILE, "w") do |file|
+        ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+      end
+    end
+
+    desc "Load a schema.rb file into the database"
+    task :load do
+      file = ENV['SCHEMA'] || SCHEMA_FILE
+      load(file)
+    end
+  end
+end

data/spec/model.rb

@@ -0,0 +1,30 @@
+require 'active_record'
+require 'acts_as_array'
+
+# create_table :users do |t|
+#   t.string :name
+# end
+# create_table :mails do |t|
+#   t.string :name
+#   t.references :user
+# end
+# create_table :phones do |t|
+#   t.string :name
+#   t.references :user
+# end
+
+class Mail < ActiveRecord::Base
+  belongs_to :user
+end
+
+class Phone < ActiveRecord::Base
+  belongs_to :user
+end
+
+class User < ActiveRecord::Base
+  include ActsAsArray
+  has_many :mails
+  has_many :phones
+  acts_as_array :mails => {:class => Mail, :field => :name},
+    :phones => {:class => Phone, :field => :name}
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rspec'
+require 'pry'
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'active_record'
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => 'db/sqlite.db'
+)
+
+#require 'rake'
+#require_relative 'migrate_tasks'
+#Rake::Task['db:schema:load'].invoke
+
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_array
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-04 00:00:00.000000000 Z
+dependencies:
+- !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: 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: pry
+  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'
+description: Treat array fields simply.
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_array.gemspec
+- db/migrate/001_create_users.rb
+- db/migrate/002_create_mails.rb
+- db/migrate/003_create_phones.rb
+- db/schema.rb
+- lib/acts_as_array.rb
+- spec/acts_as_array_spec.rb
+- spec/migrate_tasks.rb
+- spec/model.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/acts_as_array
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+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: Treat array fields simply
+test_files:
+- spec/acts_as_array_spec.rb
+- spec/migrate_tasks.rb
+- spec/model.rb
+- spec/spec_helper.rb