acts_as_type 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7c78e657132e43ae16e058423e680f67d4e548d
+  data.tar.gz: d10cab3ba979246b71fd4b2b59916dc6f1eb90c1
+SHA512:
+  metadata.gz: a0791bdc7bfd09aa9a7c369ffa5c62184669f17adf05498cddfff4a16c367b3d86017e9c701742e9ebf284f0aa7b18445437c8ce31141248ce4c7d7eaa75e06e
+  data.tar.gz: d36543b6c4af648a2971eefbb50c52b9db72369743f306257946ecfde9b4cc82311c68747fc68c6e5fe0f0272303d207a05330d95f11df75ea0c439c2a28e341

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+*.tmproj
+.rbenv-version
+.ruby-gemset
+.ruby-version
+# Appraisal generated lockfiles
+*.gemfile.lock
+.DS_Store

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem "sqlite3"
+gem "rack", "~> 1"
+
+gemspec
+
+gem "rake"
+
+group :test do
+  gem "minitest", "~> 5.0"
+  gem "test_after_commit", "~> 0.4.2"
+end

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007 David Heinemeier Hansson
+
+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 @@
+## acts_as_type

data/Rakefile

@@ -0,0 +1,34 @@
+require "rubygems"
+require "bundler/setup"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+# Run the test with "rake" or "rake test"
+desc "Default: run acts_as_type unit tests."
+task default: :test
+
+desc "Test the acts_as_type plugin."
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib" << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+begin
+  # Run the rdoc task to generate rdocs for this gem
+  require "rdoc/task"
+  RDoc::Task.new do |rdoc|
+    require "acts_as_type/version"
+    version = ActsAsType::VERSION
+
+    rdoc.rdoc_dir = "rdoc"
+    rdoc.title = "acts_as_type #{version}"
+    rdoc.rdoc_files.include("README*")
+    rdoc.rdoc_files.include("lib/**/*.rb")
+  end
+rescue LoadError
+  puts "RDocTask is not supported on this platform."
+rescue StandardError
+  puts "RDocTask is not supported on this platform."
+end

data/acts_as_type.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_type/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_type"
+  spec.version       = ActsAsType::VERSION
+  spec.authors       = ["Franky"]
+  spec.email         = ["zhanglinjie412@gmail.com"]
+  spec.description   = %q{A gem make a model attribute acts as a type}
+  spec.summary       = %q{}
+  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 'engtagger'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'activerecord', ">= 3.0"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/acts_as_type.rb

@@ -0,0 +1,112 @@
+require "acts_as_type/version"
+module ActsAsType
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # Example
+  # class Person
+  #   include ActsAsType
+  #   acts_as_type :gender, { male: "男", female: "女" }
+  # end
+  #
+  # Person.gender_values            # => [:male, :female]
+  # Person.gender_names             # => ['男', '女']
+  # Person.gender_collection        # => { male: "男", female: "女" }
+  # Person.gender_select_collection # => [["男", :male], ["女", :female]]
+  #
+  # person = Person.new(gender: :male)
+  # person.male?       # => true
+  # person.not_male?   # => false
+  # person.female?     # => false
+  # person.not_female? # => true
+  # person.gender_name # => "男"
+  #
+  # class Person < ActiveRecord::Base
+  #   acts_as_type :gender, { male: "男", female: "女" }, validate: true, scope: true
+  # end
+  #
+  # Person.male # => Person.where(gender: :male)
+  # person = Person.new(gender: "no_valid_value")
+  # person.valid? # => false
+  #
+
+  module ClassMethods
+    def acts_as_type(column, type_collection, options={})
+      is_active_record = Object.const_defined?("ActiveRecord::Base") && self < ActiveRecord::Base
+      unless is_active_record
+        attr_accessor column
+      end
+      if type_collection.is_a?(Hash)
+        type_values = type_collection.keys
+        type_names = type_collection.values
+      elsif type_collection.is_a?(Array)
+        type_values = type_collection
+        type_names = type_collection
+        type_collection = Hash[type_values.zip(type_names)]
+      end
+
+      define_singleton_method "#{column}_collection" do
+        type_collection
+      end
+
+      define_singleton_method "#{column}_select_collection" do
+        type_collection.map{|value, name| [name, value]}
+      end
+
+      define_singleton_method "#{column}_collection_as_select_data" do
+        type_collection.map{|value, name| { name: name, id: value }}
+      end
+
+      define_singleton_method "#{column}_values" do
+        type_values
+      end
+
+      define_singleton_method "#{column}_value" do |type_name|
+        (Hash[type_names.zip(type_values)][type_name] rescue nil)
+      end
+
+      define_singleton_method "#{column}_names" do
+        type_names
+      end
+
+      define_singleton_method "#{column}_name" do |type_value|
+        (Hash[type_values.zip(type_names)][type_value.to_sym] rescue nil)
+      end
+
+      self.class_eval do
+        if options[:validate]
+          allow_blank = options.fetch(:allow_blank, true)
+          if respond_to?(:validates)
+            validates column, inclusion: {:in => type_values.map{|value| [value, value.to_s]}.flatten}, allow_blank: allow_blank
+          end
+        end
+        if options[:scope] && is_active_record
+          scope column, ->(column_param){ where(column.to_sym => column_param) if column_param.present? }
+          type_values.each do |type_value|
+            scope type_value, ->{ where(column.to_sym => type_value)}
+          end
+        end
+      end
+
+      type_values.each do |type_value|
+        define_method "#{type_value}?" do
+          self.send(column).try(:to_sym) == type_value.to_sym
+        end
+
+        define_method "not_#{type_value}?" do
+          self.send(column).try(:to_sym) != type_value.to_sym
+        end
+      end
+
+      unless self.instance_methods.include?("#{column}_name".to_sym)
+        define_method "#{column}_name" do
+          type_collection.fetch(self.send(column).try(:to_sym), nil)
+        end
+      end
+
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActsAsType) if defined?(ActiveRecord)

data/lib/acts_as_type/version.rb

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

data/test/acts_as_type_test.rb

@@ -0,0 +1,93 @@
+require 'test_helper'
+
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: 'file:memdb1?mode=memory&cache=shared'
+)
+ActiveRecord::Schema.verbose = false
+
+def setup_db
+  # AR caches columns options like defaults etc. Clear them!
+  ActiveRecord::Base.connection.create_table :people do |t|
+    t.column :name, :string
+    t.column :gender, :string
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+
+  ActiveRecord::Base.connection.schema_cache.clear!
+  Person.reset_column_information
+end
+
+def teardown_db
+  if ActiveRecord::VERSION::MAJOR >= 5
+    tables = ActiveRecord::Base.connection.data_sources
+  else
+    tables = ActiveRecord::Base.connection.tables
+  end
+
+  tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Person < ActiveRecord::Base
+  acts_as_type :gender, { male: "男", female: "女" }, validate: true, scope: true
+end
+
+class NormalPerson
+  include ActsAsType
+  acts_as_type :gender, { male: "男", female: "女" }
+end
+
+class NormalArrayPerson
+  include ActsAsType
+  acts_as_type :gender, [:male, :female]
+end
+
+class ActsAsTypeTestCase < Minitest::Test
+  def teardown
+    teardown_db
+  end
+
+  def setup
+    setup_db
+  end
+
+  def test_normal_model_class_methods
+    assert_equal [:male, :female], NormalPerson.gender_values
+    assert_equal ["男", "女"], NormalPerson.gender_names
+    assert_equal({ male: "男", female: "女" }, NormalPerson.gender_collection)
+    assert_equal([["男", :male], ["女", :female]], NormalPerson.gender_select_collection)
+  end
+
+  def test_normal_model_instance_methods
+    person = NormalPerson.new
+    person.gender = :male
+    assert_equal true, person.male?
+    assert_equal false, person.not_male?
+    assert_equal false, person.female?
+    assert_equal true, person.not_female?
+    assert_equal "男", person.gender_name
+  end
+
+  def test_normal_array_model
+    assert_equal [:male, :female], NormalArrayPerson.gender_values
+    assert_equal [:male, :female], NormalArrayPerson.gender_names
+    assert_equal({ male: :male, female: :female }, NormalArrayPerson.gender_collection)
+    assert_equal([[:male, :male], [:female, :female]], NormalArrayPerson.gender_select_collection)
+  end
+
+  def test_active_record_model_validate
+    person = Person.new(gender: :no_male)
+    assert_equal false, person.valid?
+    person.gender = :male
+    assert_equal true, person.valid?
+  end
+
+  def test_active_record_model_scope
+    person = Person.create(gender: :male)
+    assert_equal 1, Person.male.count
+    assert_equal person.id, Person.male.first.id
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+require "bundler/setup"
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require "active_record"
+require "minitest/autorun"
+require "acts_as_type"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_type
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Franky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-06 00:00:00.000000000 Z
+dependencies:
+- !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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem make a model attribute acts as a type
+email:
+- zhanglinjie412@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- acts_as_type.gemspec
+- lib/acts_as_type.rb
+- lib/acts_as_type/version.rb
+- test/acts_as_type_test.rb
+- test/test_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.5.1
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- test/acts_as_type_test.rb
+- test/test_helper.rb