meta_field 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.rdoc

@@ -0,0 +1,119 @@
+= MetaField
+
+Author:: Yuichi Takeuchi uzuki05@takeyu-web.com
+Website:: http://takeyu-web.com/
+Copyright:: Copyright 2012 Yuichi Takeuchi
+License:: MIT-LICENSE.
+
+もっと柔軟にメタデータを付けたい。いちいちカラムを増やしたくない。
+
+== Installation
+
+  # your Gemfile
+  gem 'meta_field'
+
+=== Post Instration
+
+  $ rails g meta_field:migration
+  $ rake db:migrate
+
+== Usage
+
+=== メタ属性の定義
+
+モデルクラスで meta_field を宣言します。
+
+  class Book < ActiveRecord::Base
+    meta_field :released_at, :datetime
+    meta_attr :page, :integer, index: false # meta_attr は meta_field の別名
+    meta_field :note, :text, default: '(none)'
+  end
+
+STIを使うこともできます。親のメタ属性は子でも使用できます。
+
+  class Animal < ActiveRecord::Base
+    meta_field :name, :string
+  end
+
+  class Dog < Animal
+    meta_field :pedigree
+  end
+
+  class Cat < Animal
+  end
+
+=== メタ属性の使用
+
+宣言した属性名のsetter/getterが提供されます。
+
+  animal.name #=> nil
+  animal.name = "Pochi"
+  animal.name #=> "Pochi"
+  animal.save
+  Animal.find(animal.id).name #=> "Pochi"
+
+=== メタ属性による検索
+
+meta_joinスコープを利用できます。
+
+meta_joinを使うと、メタ属性を使って検索したり並び替えたりするためのサブクエリがJOINされます。
+
+  # released_atの降順でソート
+  Book.meta_join(:released_at).order('released_at DESC')
+  
+  # priceの昇順、同一の場合はreleased_atの降順でソート
+  Book.meta_join(:released_at, :price).order('price ASC, released_at DESC')
+
+  # priceで検索
+  Book.meta_join(:price).where(Arel.sql('price BETWEEN 1000 AND 2000')).order('price ASC')
+  # メタ属性でない通常の属性と組み合わせた検索もできます。
+  Book.meta_join(:price).where(t.arel_table[:hoge].matches('%HOGE%').and(Arel.sql('price BETWEEN 1000 AND 2000'))).order('price ASC')
+
+JOIN対象を少なくするために、JOINの前に検索しておきたい場合は、 .meta_join に、属性名をキーに、検索条件を値とするハッシュを渡します。
+
+  # released_atが1年前より新しものを検索しからJOINし、価格の昇順でソート
+  Book.meta_join(:released_at: Book.meta[:released_at].gt(1.years.ago)).meta_join(:price).order(:price)
+  # または、検索条件無し=nilとして
+  Book.meta_join(:released_at: Book.meta[:released_at].gt(1.years.ago), price: nil).order(:price)
+
+.meta[:released_at] は、メタ属性で検索を行う場合に、そのままではメタ属性の型毎に別々のカラムに入っていたり非常に扱いにくいため、これを緩和するプロキシオブジェクトを返します。
+.meta_join内で、Arelを使った条件組み立てを行う際に、.arel_table[:hoge]と同じ感じで使用します。
+
+
+== 関連先モデルのメタ属性による検索
+
+サブクエリのJOINを使用して下さい。
+
+  # 21歳から39歳の著者の本を出版日の降順で取り出す
+  # 「21歳から39歳の著者」を検索するサブクエリ組み立て
+  books_table = Book.arel_table
+  selected_authors_table = Author.meta_join(age: Author.meta[:age].gt(20).and(Author.meta[:age].lt(40))).arel.as('selected_authors')
+  # JOINして、「出版日の降順」のSQLを組み立てる
+  sql = Book.meta_join(:released_at).arel
+    .join(selected_authors_table, Arel::Nodes::InnerJoin)
+    .on(books_table[:author_id].eq(selected_authors_table[:id]))
+    .order('released_at DESC').to_sql
+  # 検索実行
+  books = Book.find_by_sql(sql)
+
+
+== インデックスの使用
+
+検索のためのINDEXは、デフォルトで値に対して使用されます。（:text / :binary を除く）
+検索が不要なメタ属性は index: false とすることで、明示的にインデックスの使用をキャンセルできます。
+
+
+== 型などの変更
+
+型ごとに別々のカラムにデータが格納されるため、途中から型を変更すると、変更前の値を取得できなくなります。（未設定扱いになります）
+
+インデックスを使用する属性と使用しない属性では、利用されるカラムが異なるため、途中からインデックスの使用・不使用を変更した場合も同様です。
+
+
+== 注意
+
+- 仕様変更があっても泣かない。
+
+- バグっても泣かない。
+
+- 何が起きても責任はとれません。

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MetaField'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/generators/meta_field/migration/migration_generator.rb

@@ -0,0 +1,38 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module MetaField
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for MetaField models"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        migration_number += 1
+        migration_number.to_s
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/meta_field_migration'
+      end
+    end
+  end
+end

data/lib/generators/meta_field/migration/templates/active_record/migration.rb

@@ -0,0 +1,42 @@
+class MetaFieldMigration < ActiveRecord::Migration
+  def change
+    create_table :meta_field_metas do |t|
+      t.integer :obj_id
+      t.string :obj_type
+      t.string :basename
+
+      t.string :string
+      t.text :text
+      t.integer :integer
+      t.float :float
+      t.decimal :decimal
+      t.datetime :datetime
+      t.timestamp :timestamp
+      t.time :time
+      t.date :date
+      t.binary :binary
+      t.boolean :boolean
+      t.string :indexed_string
+      t.integer :indexed_integer
+      t.float :indexed_float
+      t.decimal :indexed_decimal
+      t.datetime :indexed_datetime
+      t.timestamp :indexed_timestamp
+      t.time :indexed_time
+      t.date :indexed_date
+      t.boolean :indexed_boolean
+    end
+    add_index :meta_field_metas, [:obj_id, :obj_type]
+    add_index :meta_field_metas, [:obj_id, :obj_type, :basename]
+
+    add_index :meta_field_metas, :indexed_string
+    add_index :meta_field_metas, :indexed_integer
+    add_index :meta_field_metas, :indexed_float
+    add_index :meta_field_metas, :indexed_decimal
+    add_index :meta_field_metas, :indexed_datetime
+    add_index :meta_field_metas, :indexed_timestamp
+    add_index :meta_field_metas, :indexed_time
+    add_index :meta_field_metas, :indexed_date
+    add_index :meta_field_metas, :indexed_boolean
+  end
+end

data/lib/meta_field.rb

@@ -0,0 +1,6 @@
+module MetaField
+  autoload :Meta, 'meta_field/meta'
+end
+
+require 'meta_field/railtie'
+

data/lib/meta_field/extension.rb

@@ -0,0 +1,174 @@
+# -*- coding: utf-8 -*-
+require 'meta_field/proxy'
+
+module MetaField
+  module Extension
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        def inherited_with_meta_field(klass) #:nodoc:
+          inherited_without_meta_field klass
+          if klass != MetaField::Meta
+            klass.class_eval do
+              scope :meta_join, ->(*args){ _meta_join(*args) }
+            end
+            klass.send(:include, MetaField::ModelExtension) if klass.superclass == ActiveRecord::Base
+          end
+        end
+        alias_method_chain :inherited, :meta_field
+      end
+
+      descendants.each do |klass|
+        if klass != MetaField::Meta
+          klass.class_eval do
+            scope :meta_join, ->(*args){ _meta_join(*args) }
+          end
+          klass.send(:include, MetaField::ModelExtension) if klass.superclass == ActiveRecord::Base
+        end
+      end
+      
+    end
+  end
+  
+  module ModelExtension
+    extend ActiveSupport::Concern
+    
+    included do
+      after_save :save_meta_metas
+      
+      has_many :metafield_metas, class_name: 'MetaField::Meta', as: :obj, dependent: :destroy
+      
+      class << self
+
+        # メタ属性を検索・ソートに使うためにJOIN
+        # 
+        #   # released_atの降順でソート
+        #   Book.meta_join(:released_at).order('released_at DESC')
+        #
+        #   # priceの昇順、同一の場合はreleased_atの降順でソート
+        #   Book.meta_join(:released_at, :price).order('price ASC, released_at DESC')
+        #
+        #   # released_atが1年前より新しものを検索し、価格の昇順でソート
+        #   Book.meta_join(:released_at: Book.meta[:released_at].gt(1.years.ago), price: nil).order(:price)
+        # 
+        # scope ではSTIに対応できなかったのでscopeはinheritedで全クラスで定義し、クラスメソッドを呼ぶ形で対処
+        # scope :meta_join, ->(*args) do
+        def _meta_join(*args)
+          basenames = {}
+          case args.size
+          when 1
+            case args[0]
+            when Hash
+              basenames = args[0].dup
+            else
+              basenames[args[0]] = nil
+            end
+          else
+            args.each{|arg| basenames[arg] = nil }
+          end
+          query = scoped
+          basenames.each{ |basename, where_cond|
+            quoted_basename = connection.quote_string(basename.to_s)
+            sub = MetaField::Meta.arel_table
+            sub = sub.where(sub[:basename].eq(basename))
+            sub = sub.where(where_cond) if where_cond
+            sub = sub.project(Arel.sql("#{connection.quote_column_name('obj_id')} as #{ connection.quote_column_name(quoted_basename+'_obj_id') }, #{connection.quote_column_name(meta_fields[basename.to_sym][0])} as #{connection.quote_column_name(quoted_basename)}"))
+            query = query.joins("INNER JOIN (#{ sub.to_sql }) ON  #{connection.quote_table_name(table_name)}.#{connection.quote_column_name('id')} = #{connection.quote_column_name(quoted_basename+'_obj_id')}")
+          }
+          query
+        end
+        private :_meta_join
+        
+        def meta_fields
+          return @meta_fields if @meta_fields
+          ancestors_meta_fields = self.superclass == ActiveRecord::Base ? {} : self.superclass.meta_fields
+          @meta_fields = Marshal.load(Marshal.dump(ancestors_meta_fields))
+        end
+      end
+
+    end
+
+    module ClassMethods
+      # メタ属性を追加する
+      # 
+      #   class Book < ActiveRecord::Base
+      #     attr_accessible :name, :released_at, :subtitle, :note
+      #     meta_field :released_at, :datetime
+      #     meta_field :subtitle,    :string
+      #     meta_field :page,        :integer,  index: false
+      #     meta_field :note,        :text,     default: '特記事項無し'
+      #   end
+      def meta_field(basename, datatype, meta_options = nil)
+        meta_options = {index: true}.merge(meta_options || {})
+        meta_options[:index] = false if [:text, :binary].include?(datatype.to_sym)
+        datatype = "indexed_#{datatype}" if meta_options[:index]
+        meta_fields[basename.to_sym] = [datatype.to_sym, meta_options]
+        class_eval <<CODE
+          def #{basename}_record
+            unless @attributes_cache[:#{basename}_record]
+              query = metafield_metas.where(basename: #{basename.to_s.inspect})
+              unless obj = query.first
+                obj = query.build
+                obj.#{datatype} = self.class.meta_fields[:#{basename}][1][:default]
+              end
+              @attributes_cache[:#{basename}_record] = obj
+            end
+            @attributes_cache[:#{basename}_record]
+          end
+          private :#{basename}_record
+
+          def #{basename}
+            #{basename}_record.#{datatype}
+          end
+
+          def #{basename}=(value)
+            #{basename}_record.#{datatype} = value
+          end
+CODE
+      end
+      alias :meta_attr :meta_field
+      alias :meta_column :meta_field
+      
+     
+      # meta_join でメタ属性での絞り込みを行う際にArelっぽく標記するために使うProxyを得る
+      # メタ属性は単純なカラム名で扱うことができないため、Proxyを通して操作する
+      #
+      #   Book.meta_join(:subtitle: Book.meta[:subtitle].matches_any(['%KEYWORD1%', '%KEYWORD2%']))
+      #   # => SELECT "books".*
+      #   #    FROM "books" INNER JOIN (
+      #   #      SELECT "obj_id" as "note_obj_id", "text" as "note"
+      #   #      FROM "meta_field_metas"
+      #   #      WHERE
+      #   #        "meta_field_metas"."obj_type" = 'Book' AND "meta_field_metas"."basename" = 'note' AND
+      #   #        ("meta_field_metas"."text" LIKE '%HOGE%' OR "meta_field_metas"."text" LIKE '%FUGA%')
+      #   #    ) ON "books"."id" = "note_obj_id"
+      #
+      #
+      #   Author.meta_join(:age: Author.meta[:age].gt(20).and(Author.meta[:age].lt(40))).order(:age)
+      #   # => SELECT "authors".*
+      #   #    FROM "authors" INNER JOIN (
+      #   #      SELECT "obj_id" as "age_obj_id", "integer" as "age"
+      #   #      FROM "meta_field_metas"
+      #   #      WHERE
+      #   #        "meta_field_metas"."obj_type" = 'Author' AND "meta_field_metas"."basename" = 'age AND
+      #   #        "meta_field_metas"."integer" > 20 AND "meta_field_metas"."integer" < 40
+      #   #     ) ON  "authors"."id" = "age_obj_id"
+      #   #     ORDER BY age
+
+      def meta
+        MetaField::MetaProxy.new(self)
+      end
+    end
+
+    def save_meta_metas
+      self.class.meta_fields.keys.each do |basename|
+        meta_record = send("#{basename}_record")
+        meta_record.obj ||= self
+        meta_record.save
+      end
+    end
+    private :save_meta_metas
+
+  end
+end

data/lib/meta_field/meta.rb

@@ -0,0 +1,4 @@
+class MetaField::Meta < ActiveRecord::Base
+  self.table_name = :meta_field_metas
+  belongs_to :obj, polymorphic: true
+end

data/lib/meta_field/proxy.rb

@@ -0,0 +1,24 @@
+module MetaField
+  class MetaProxy
+    def initialize(klass)
+      @klass = klass
+      @type = klass.base_class.to_s
+    end
+    def [](basename)
+      t = MetaField::Meta.arel_table
+      NodeProxy.new(@klass.meta_fields[basename.to_sym][0], t[:obj_type].eq(@type).and(t[:basename].eq(basename.to_s)))
+    end
+  end
+  
+  class NodeProxy
+    def initialize(datatype, obj)
+      @datatype = datatype
+      @obj = obj
+    end
+    
+    def method_missing(action, *args)
+      @obj.and(MetaField::Meta.arel_table[@datatype].send(action, *args))
+    end 
+  end
+
+end

data/lib/meta_field/railtie.rb

@@ -0,0 +1,10 @@
+module MetaField
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'meta_field' do |_app|
+      ActiveSupport.on_load(:active_record) do
+        require 'meta_field/extension'
+        ::ActiveRecord::Base.send :include, MetaField::Extension
+      end
+    end
+  end
+end

data/lib/meta_field/version.rb

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

data/lib/tasks/meta_field_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :meta_field do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: meta_field
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yuichi Takeuchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: ActiveRecord meta_field for Rails 3
+email:
+- uzuki05@takeyu-web.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tasks/meta_field_tasks.rake
+- lib/meta_field/railtie.rb
+- lib/meta_field/proxy.rb
+- lib/meta_field/extension.rb
+- lib/meta_field/version.rb
+- lib/meta_field/meta.rb
+- lib/meta_field.rb
+- lib/generators/meta_field/migration/templates/active_record/migration.rb
+- lib/generators/meta_field/migration/migration_generator.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://takeyu-web.com/
+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.23
+signing_key: 
+specification_version: 3
+summary: ActiveRecord meta_field for Rails 3
+test_files: []