easy_model 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21ecfa2162298fa25b4bbf17662ae0a128cddbc7
-  data.tar.gz: 52241b8089b95c6d9c80b141c61a7c28b5023286
+  metadata.gz: 488a9ff8518bfe55261101a3cf8eb59db5d259af
+  data.tar.gz: a47ae035674368c4a3c356b2b37c7440b71fb938
 SHA512:
-  metadata.gz: 1955d4b89055454fa57d6b1333999dbf8aa30e15cf923e9d0acf664d4ba34e59d166510924a72d0c056923abb3b95559c9dca70e9048224886d5cce459e6515a
-  data.tar.gz: a752cf393cdd56cfd618eaf756492a6e4628c7a99667262af1223a07c94f8242705922758500540163cfe9f065dc0bca02c96aa2ce46bdf78eabe519d8b433ca
+  metadata.gz: e735726fc401878ff30c6d85f77d58e7a4d5346d322488aedb7ec0e03bc03a368912a9df3e0fab1ca65b748774f30847d353db10248c578cbe3f6be1dacdb853
+  data.tar.gz: b1b90d7f46091973c003cc1c39f8a06c5420cde4785449e4e9bfa74e721ba8f364cd17c7b39d80ddbe7e1aee9d1f82f6c4c9b47a9b90bdeee3fea28d62a117d3

data/Gemfile

@@ -1,12 +1,16 @@
 source 'https://rubygems.org'
 
-gem 'activemodel', '~> 3.0'
-gem 'activerecord', '~> 3.0'
+gem 'activemodel', '~> 4.0'
+gem 'activerecord', '~> 4.0'
 
 group :development do
   gem 'rdoc', '>= 3.12'
   gem 'bundler', '>= 1.0.0'
   gem 'jeweler', '>= 1.8.4'
+end
+
+group :test do
   gem 'simplecov', '>= 0'
+  gem 'sqlite3'
 end
 

data/README.rdoc

@@ -1,53 +1,23 @@
 = easy_model
 
-データベースに関連付かないモデルの基本クラスや,
-代入時に ActiveRecord と同じ型変換が行われる属性を定義する機能を提供します.
+EasyModel provides features of database independent attribute.
+You can define the attribute like ActiveRecord that perform data conversion during assignment.
 
-== データベースに関連付かないモデル, 属性
+== Define database independent attribute
 
-Rails3 ではネーミングルールやバリデーションを扱う機能がモジュール分けされているため,
-それらのモジュールを再利用することでデータベースに関連付かないモデルを作成することができます.
-コーディング自体は簡単ですが, いくつもあるモジュールを include するコードを何度も書くことは手間です.
+First, include EasyModel to your model. Next define attribute by `column` method.
 
-EasyModel::Base はデータベースに関連付かないモデルの基本クラスです.
-以下のように EasyModel::Base を継承すれば, そのような手間を省くことができます.
+    class LoginForm
 
-    #
-    # ログインフォーム.
-    #
-    class LoginForm < EasyModel::Base
-
-      ...
-
-    end
-
-属性を定義する場合は, 以下のように attr_accessor ではなく column メソッドを使用します.
-column メソッドを使用すると, 属性の型とデフォルト値を指定することができます.
-
-    #
-    # ログインフォーム.
-    #
-    class LoginForm < EasyModel::Base
+      include EasyModel::Column
 
-      # 会員番号.
       column :member_no, :integer
-
-      validates :member_no,
-                :presence     => true,
-                :numericality => {:only_integer => true}
-
-      # パスワード.
       column :password, :string
-
-      validates :password,
-                :presence => true
-
-      # ログイン状態を保持する (デフォルトは true).
-      column :remember, :boolean, :default => true
+      column :remember, :boolan, default: false
 
     end
 
-column メソッドで定義した属性は, 代入時に ActiveRecord と同様の型変換が行われます.
+When you assign a value to attribute defined by `column` method, a value is converted to attribute's data type (like ActiveRecord).
 
     login_form = LoginForm.new(:member_no => '1234567',
                                :password  => 'PASSWORD',
@@ -60,35 +30,27 @@ column メソッドで定義した属性は, 代入時に ActiveRecord と同様
     login_form.remember                   # => false
     login_form.remember_before_type_cast  # => 'false'
 
-EasyModel::Column モジュールを include することで,
-EasyModel::Base を継承しないモデルでも column メソッドを使用することができます.
-
-    class User < ActiveRecord::Base
-
-      include EasyModel::Column
-
-      column ...
+== Internationalization
 
-    end
-
-== 国際化
-
-国際化は I18n で行われます.
-デフォルトでは '<locale>.easy_model' 以下がルックアップされます.
+EasyModel uses I18n to internationalization.
+By default, the look up key is `<locale>.easy_model`.
 
-  ja:
+  en:
     easy_model:
       models:
-        user_search_form: 会員検索フォーム
+        login_form: Login form
       attributes:
-        user_search_form:
-          name: 会員名
-          status: ステータス
+        login_form:
+          member_no: Member number
+          password: Password
+          remember: Keep the login state.
 
-EasyModel::Base.i18n_scope を上書きすることで, ルックアップされるキーを変更することができます.
-例えば, ActiveRecord と同じキーを参照させたい場合は, 以下のように上書きします.
+By define the `i18n_scope` method, you can change the look up key.
+For example, to use the look up key same as ActiveRecord:
 
-    class UserSearchForm < EasyModel::Base
+    class LoginForm
+
+      include EasyModel::Column
 
       def self.i18n_scope
         :activerecord
@@ -96,45 +58,37 @@ EasyModel::Base.i18n_scope を上書きすることで, ルックアップされ
 
     end
 
-== 検索フォーム
+== Search form
 
-検索フォームを表すモデルを作成する場合は, EasyModel::SearchForm を利用すると便利です.
-EasyModel::SearchForm は EasyModel::Base に検索用に便利な機能を追加したクラスです.
-EasyModel::SearchForm を継承したクラスは ActiveRecord::Relation を返す scoped メソッドを定義する必要があります.
+EasyModel::SearchForm is useful to create search form model.
+EasyModel::SearchForm includes EasyModel::Column, and provides useful features to searching.
+Only define the `scoped` method, you can use query method same as ActiveRecord.
 
-以下に実装例を示します.
+For example:
 
-    #
-    # 会員検索フォーム.
-    #
     class UserSearchForm < EasyModel::SearchForm
 
-      # 会員名.
       column :name, :string
 
-      # ステータス.
       column :status, :integer
 
       validates :status, :inclusion => [1, 2, 3]
 
-      #
-      # 検索条件を保持する ActiveRecord::Relation を返す.
-      #
       def scoped
-        scoped = User.scoped
+        scoped = User.all
 
-        # 値が設定されている場合のみ検索条件に加える.
+        # Add to conditions if value is present.
         scoped = scoped.where(:name => name) if self.name.present?
         scoped = scoped.where(:status => status) if self.status.present?
 
-        # 検索条件を含む scope を返す.
+        # Return scope including search conditions.
         scoped
       end
 
     end
 
-EasyModel::SearchForm は find や all などのメソッドを scoped メソッドに移譲します.
-そのため, 以下のように ActiveRecord::Relation と同じインタフェースで利用することができます.
+Query methods (i.e. find, all, ...) is delegated to `scoped` method.
+So, you can use the interface same as ActiveRecord::Relation.
 
     user_search_form = UserSearchForm.new(params[:user_search_form])
 

data/README_ja.rdoc

@@ -0,0 +1,104 @@
+= easy_model
+
+データベースに関連付かない属性を定義する機能を提供します.
+代入時に ActiveRecord と同様の型変換が行われる属性を定義することができます.
+
+== データベースに関連付かない属性の定義
+
+EasyModel::Column モジュールを include し, column メソッドで属性を定義します.
+
+    class LoginForm
+
+      include EasyModel::Column
+
+      column :member_no, :integer
+      column :password, :string
+      column :remember, :boolan, default: false
+
+    end
+
+column メソッドで定義した属性は ActiveRecord と同様のデータ型変換が行われます.
+
+    login_form = LoginForm.new(:member_no => '1234567',
+                               :password  => 'PASSWORD',
+                               :remember  => 'false')
+
+    login_form.member_no                  # => 1234567
+    login_form.member_no_before_type_cast # => '1234567'
+    login_form.password                   # => 'PASSWORD'
+    login_form.password_before_type_cast  # => 'PASSWORD'
+    login_form.remember                   # => false
+    login_form.remember_before_type_cast  # => 'false'
+
+== 国際化
+
+国際化は I18n で行われます.
+デフォルトでは '<locale>.easy_model' 以下がルックアップされます.
+
+  ja:
+    easy_model:
+      models:
+        login_form: ログインフォーム
+      attributes:
+        login_form:
+          member_no: 会員番号
+          password: パスワード
+          remember: ログイン状態を記憶する
+
+i18n_scope メソッドを上書きすることで, ルックアップされるキーを変更することができます.
+例えば, ActiveRecord と同じキーを参照させたい場合は, 以下のように上書きします.
+
+    class LoginForm
+
+      include EasyModel::Column
+
+      def self.i18n_scope
+        :activerecord
+      end
+
+    end
+
+== 検索フォーム
+
+検索フォームを表すモデルを作成する場合は EasyModel::SearchForm を利用すると便利です.
+EasyModel::SearchForm は EasyModel::Column を include した上で検索に便利な機能を追加したクラスです.
+scoped メソッドを定義するだけで ActiveRecord が持つ検索形のメソッドなどを利用できるようになります.
+
+以下に実装例を示します.
+
+    class UserSearchForm < EasyModel::SearchForm
+
+      column :name, :string
+
+      column :status, :integer
+
+      validates :status, :inclusion => [1, 2, 3]
+
+      def scoped
+        scoped = User.scoped
+
+        # 値が設定されている場合のみ検索条件に加える.
+        scoped = scoped.where(:name => name) if self.name.present?
+        scoped = scoped.where(:status => status) if self.status.present?
+
+        # 検索条件を含む scope を返す.
+        scoped
+      end
+
+    end
+
+EasyModel::SearchForm は find や all などのメソッドを scoped メソッドに移譲します.
+そのため, 次のように ActiveRecord::Relation と同じインタフェースで利用することができます.
+
+    user_search_form = UserSearchForm.new(params[:user_search_form])
+
+    if user_search_form.valid?
+      users = user_search_form.all
+    else
+      ...
+    end
+
+== Copyright
+
+Copyright (c) 2012 Synergy Marketing, Inc. See LICENSE.txt for further details.
+

data/VERSION

@@ -1 +1 @@
-1.0.5
+2.0.0

data/easy_model.gemspec

@@ -5,31 +5,35 @@
 
 Gem::Specification.new do |s|
   s.name = "easy_model"
-  s.version = "1.0.5"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["SUZUKI Kei"]
-  s.date = "2013-10-12"
+  s.date = "2013-10-14"
   s.description = "\u{30c7}\u{30fc}\u{30bf}\u{30d9}\u{30fc}\u{30b9}\u{306b}\u{4f9d}\u{5b58}\u{3057}\u{306a}\u{3044}\u{30e2}\u{30c7}\u{30eb}\u{306e}\u{57fa}\u{672c}\u{30af}\u{30e9}\u{30b9}\u{3084}, ActiveRecord \u{3068}\u{540c}\u{3058}\u{578b}\u{5909}\u{63db}\u{3092}\u{884c}\u{3046}\u{5c5e}\u{6027}\u{5b9a}\u{7fa9}\u{30e1}\u{30bd}\u{30c3}\u{30c9}\u{3092}\u{63d0}\u{4f9b}\u{3057}\u{307e}\u{3059}."
   s.email = "info-techscore@synergy101.jp"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.rdoc",
+    "README_ja.rdoc"
   ]
   s.files = [
     "Gemfile",
     "LICENSE.txt",
     "README.rdoc",
+    "README_ja.rdoc",
     "Rakefile",
     "VERSION",
     "easy_model.gemspec",
     "lib/easy_model.rb",
     "lib/easy_model/base.rb",
     "lib/easy_model/column.rb",
+    "lib/easy_model/column_for_active_model.rb",
+    "lib/easy_model/column_for_active_record.rb",
     "lib/easy_model/search_form.rb",
     "test/easy_model/ja.yml",
-    "test/easy_model/test_base.rb",
-    "test/easy_model/test_column.rb",
+    "test/easy_model/test_column_for_active_model.rb",
+    "test/easy_model/test_column_for_active_record.rb",
     "test/easy_model/test_search_form.rb",
     "test/helper.rb"
   ]
@@ -43,27 +47,24 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activemodel>, ["~> 3.0"])
-      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<activemodel>, ["~> 4.0"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 4.0"])
       s.add_development_dependency(%q<rdoc>, [">= 3.12"])
       s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
     else
-      s.add_dependency(%q<activemodel>, ["~> 3.0"])
-      s.add_dependency(%q<activerecord>, ["~> 3.0"])
+      s.add_dependency(%q<activemodel>, ["~> 4.0"])
+      s.add_dependency(%q<activerecord>, ["~> 4.0"])
       s.add_dependency(%q<rdoc>, [">= 3.12"])
       s.add_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_dependency(%q<jeweler>, [">= 1.8.4"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<activemodel>, ["~> 3.0"])
-    s.add_dependency(%q<activerecord>, ["~> 3.0"])
+    s.add_dependency(%q<activemodel>, ["~> 4.0"])
+    s.add_dependency(%q<activerecord>, ["~> 4.0"])
     s.add_dependency(%q<rdoc>, [">= 3.12"])
     s.add_dependency(%q<bundler>, [">= 1.0.0"])
     s.add_dependency(%q<jeweler>, [">= 1.8.4"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
   end
 end
 

data/lib/easy_model/base.rb

@@ -1,67 +1,11 @@
 # coding: utf-8
 
-require 'active_model'
-
-#
-# テーブルに依存しないモデルの基本クラス.
-#
 class EasyModel::Base
 
-  extend ActiveModel::Naming
-  include ActiveModel::Conversion
-  include ActiveModel::Validations
   include EasyModel::Column
 
-  #
-  # ロケールファイルからルックアップするときのキー.
-  #
-  def self.i18n_scope
-    :easy_model
-  end
-
-  #
-  # 指定された属性値で初期化する.
-  #
-  # ==== 引数
-  # attributes::
-  #   属性名と属性値を保持する Hash.
-  #
-  def initialize(attributes=nil)
-    assign_attributes(attributes)
-  end
-
-  #
-  # 属性を一括代入する.
-  #
-  # ==== 引数
-  # new_attributes::
-  #   属性名と属性値を保持する Hash.
-  #
-  def attributes=(new_attributes)
-    assign_attributes(new_attributes)
-  end
-
-  #
-  # 属性を一括代入する.
-  #
-  # ==== 引数
-  # new_attributes::
-  #   属性名と属性値を保持する Hash.
-  #
-  def assign_attributes(new_attributes)
-    (new_attributes || {}).each do |name, value|
-      send("#{name}=", value)
-    end
-  end
-
-  #
-  # オブジェクトが永続化されているか判定する.
-  #
-  # ==== 戻り値
-  # DB に関連付かないモデルのため常に false.
-  #
-  def persisted?
-    false
+  def self.inherited(base)
+    $stderr.puts 'DEPRECATED: EasyModel::Base is deprecated. Instead to include EasyModel::Column.'
   end
 
 end