active_value 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a56662308895b1d1a241aa5fb1bdce5fa1e6f31f2aac1bfb18e40494d1009e91
-  data.tar.gz: faaa8dc8e12044fd001d10cc79e01fed871196f4c584020081bb9bb797c705d7
+  metadata.gz: 5072b5c5ad5e643c3bdc8c9986be317b3badfce1bfce29e79c07795046113957
+  data.tar.gz: 89956a9fefb5ba8a6e7a4ca70b3bb5cfab527fc0a133d830790659d8a5e99d5d
 SHA512:
-  metadata.gz: 37f355f81ed2051dd54f097156d9a415f37f61df4861ec96c935543f894c2ee6ace4c4cce2a46eb016e5ac8cd00844d24353f7e694a7bae4f17093cab1f10a23
-  data.tar.gz: '0758dec3aff5b9c595c9f8541361617cba4804a265797b4a4bb1ccb1b0e8156de1ff31e6f0056d5b0285f7c2d244b800d31d768ae9163c3f7c2b02cc4d2c604e'
+  metadata.gz: cb9ac9c497dce8199818f4d59a694f8fd8f016313eca4e8a893428d706ab233bf1d01cba0c258258a4b3dcf348c9cebc8a7a8dabd88072fa09043986374d7024
+  data.tar.gz: e61bc5891f72b87fff0ecf593b0037792cea63e1114f515d2c732e6ebdba47ebe1f55310a9ceef92a1821ff5eafebd008372addd1ed96f1f53c50e8940439451

data/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish
+on:
+  workflow_dispatch:
+  push:
+    branches: [ $default-branch ]
+    tags:
+      - v*
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 3.0
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+      - name: Publish to GitHub Package Repository
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        env:
+          GEM_HOST_API_KEY: "Bearer ${{ secrets.GITHUB_TOKEN }}"
+          OWNER: ${{ github.repository_owner }}
+        continue-on-error: true
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_AUTH_TOKEN }}"
+        continue-on-error: true

data/.github/workflows/test.yml

@@ -0,0 +1,16 @@
+name: Test
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [3.0, 2.7, 2.3]
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake

data/README.md

@@ -1,8 +1,12 @@
-# ActiveValue
+![TEST](https://img.shields.io/github/workflow/status/hiratai/active_value/Test?style=for-the-badge)
+![RELEASE_VERSION](https://img.shields.io/github/v/release/hiratai/active_value?style=for-the-badge)
+![GEM_VERSION](https://img.shields.io/gem/v/active_value?style=for-the-badge)
+![LICENSE](https://img.shields.io/github/license/hiratai/active_value?style=for-the-badge)
 
-Model for non database. (ValueObject)  
-However like ActiveRecord.
+# ActiveValue
 
+ActiveValue::Base is base class for immutable value object that has interfaces like ActiveRecord.  
+In a class inherited this class, constant variables get the behavior like records of ActiveRecord.
 
 ## Installation
 
@@ -14,7 +18,7 @@ gem 'active_value'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -23,19 +27,40 @@ Or install it yourself as:
 
 ## Usage
 
+1. Define the target class inherited from ActiveValue::Base
+2. List attributes of the object using attr_accessor
+3. Declare constant variables as this instance in this class
+
 ```ruby
-class QuestionType < ActiveValue::Base
- 
+class FormCategory < ActiveValue::Base
+
   attr_accessor :id, :symbol, :name
-  
-  Checkbox  = new id: 1, symbol: :checkbox, name: "Check Box"
-  Radio     = new id: 2, symbol: :radio,    name: "Radio Button"
-  Selectbox = new id: 3, symbol: :select,   name: "Select Box"
-  Text      = new id: 4, symbol: :text,     name: "Text Box"
-  TextArea  = new id: 5, symbol: :textarea, name: "Text Area"
-  
+
+  CHECK_BOX  = new id: 1, symbol: :checkbox, name: "Check Box"
+  RADIO      = new id: 2, symbol: :radio,    name: "Radio Button"
+  SELECT_BOX = new id: 3, symbol: :select,   name: "Select Box"
+  TEXT       = new id: 4, symbol: :text,     name: "Text Box"
+  TEXTAREA   = new id: 5, symbol: :textarea, name: "Text Area"
+
 end
 ```
+Then, constant variables in the class can be accessed by following methods.
+```ruby
+FormCategory.find(1)
+=> <#FormCategory id: 1, symbol: :checkbox, name: "Check Box" >
+
+FormCategory.find_by(symbol: :radio).name
+=> "Radio Button"
+
+FormCategory.find(1).checkbox?
+=> true
+
+FormCategory.pluck(:id, :name)
+=> [[1, "Check Box"], [2, "Radio Button"], [3, "Select Box"], ...]
+
+FormCategory.find(2).to_h
+=> { :id => 2, :symbol => :radio, :name => "Radio Button" }
+```
 
 
 ## Contributing

data/active_value.gemspec

@@ -7,22 +7,13 @@ Gem::Specification.new do |spec|
   spec.name          = "active_value"
   spec.version       = ActiveValue::VERSION
   spec.authors       = ["Taiki Hiramatsu"]
-  spec.email         = ["ta.hi.samba@gmail.com"]
+  spec.email         = ["info@hiramatsu-sa-office.jp"]
 
-  spec.summary       = %q{Model for non database.(ValueObject) However like ActiveRecord.}
-  #spec.description   = %q{}
+  spec.summary       = %q{ActiveValue is base class for immutable value object that has interfaces like ActiveRecord.}
+  spec.description   = %q{In a class inherited this class, constant variables get the behavior like records of ActiveRecord.}
   spec.homepage      = "https://github.com/hiratai/active_value"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
-
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -30,9 +21,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.required_ruby_version = ">= 2.3"
+
+  spec.add_development_dependency "bundler", "> 1.0.0"
+  spec.add_development_dependency "rake", "> 10.0"
+  spec.add_development_dependency "minitest", "> 5.0"
 
-  spec.add_dependency "activesupport"
+  spec.add_dependency "activesupport", "~> 5.2.4"
 end

data/lib/active_value.rb

@@ -1,5 +1,5 @@
+require "active_support/dependencies/autoload"
 require "active_support/core_ext"
-require "active_support/dependencies"
 require "active_value/version"
 
 module ActiveValue

data/lib/active_value/base.rb

@@ -1,51 +1,82 @@
 require "active_support/core_ext/hash/keys"
+require "json"
 
 module ActiveValue
-  # TODO: English Translation
-  # ActiveRecordライクに定数を定義するための基底クラス
-  # このクラスを継承したクラス内で宣言した定数をレコードとして扱うことができる。
-  # 継承先のクラスでattr_accessorで要素を定義することで、その要素をDBのカラムのように扱うことができる。
+  # ActiveValue::Base is base class for immutable value object that has interfaces like ActiveRecord.
+  # In a class inherited this class, constant variables get the behavior like records of ActiveRecord.
   #
-  # いくつかの要素名は予約されていて、定義があれば対応したメソッドが使用可能。
-  #  要素名 : メソッド
-  #  id : find
-  #  symbol : define_question_methods
+  # Usage.
+  #   1. Define the target class inherited from ActiveValue::Base
+  #   2. List attributes of the object using attr_accessor
+  #   3. Declare constant variables as this class
   #
+  # Example.
+  #   class QuestionType < ActiveValue::Base
+  #     attr_accessor :id, :symbol, :name
+  #     CHECKBOX  = new id: 1, symbol: :checkbox, name: "Check Box"
+  #     RADIO     = new id: 2, symbol: :radio,    name: "Radio Button"
+  #     SELECTBOX = new id: 3, symbol: :select,   name: "Select Box"
+  #     TEXT      = new id: 4, symbol: :text,     name: "Text Box"
+  #     TEXTAREA  = new id: 5, symbol: :textarea, name: "Text Area"
+  #   end
+  #   QuestionType.find(1)
+  #   => QuestionType::CHECKBOX
+  #   QuestionType.find(1).name
+  #   => "Check Box"
+  #   QuestionType.find(1).checkbox?
+  #   => true
+  #   QuestionType.pluck(:id, :name)
+  #   => [[1, "Check Box"], [2, "Radio Button"], [3, "Select Box"], ...]
+
   class Base
 
-    # 未定義のメソッド呼び出しはall(Array)に委譲
+    # Delegate undefined method calls to `all` method (returns Array).
     def self.method_missing(method, *args, &block)
       all.public_send(method, *args, &block)
     end
 
-    # ActiveRecordライクに使えるfind, find_by, all, pluckを定義
-    def self.find(index); find_by(id: index); end
+    # Getter interface by the id element like `find` method in ActiveRecord.
+    def self.find(index)
+      object = all.bsearch { |object| object.public_send(:id) >= index }
+      object&.id == index ? object : nil
+    end
+
+    # Getter interface by the argument element like `find_by` method in ActiveRecord.
     def self.find_by(conditions)
-      all.find do |object|
+      unsorted_all.find do |object|
         conditions.all? { |key, value| object.public_send(key) == value }
       end
     end
+
+    # Get all constant instances. (Unsorted)
+    def self.unsorted_all
+      constants.collect { |name| const_get(name) }.select { |object| object.instance_of?(self) }
+    end
+
+    # Get all constant instances. (Sorted by the first defined accessor)
     def self.all
-      constants.collect { |name| const_get(name) }.sort
+      unsorted_all.sort
     end
+
+    # Get attributes
     def self.pluck(*accessors)
-      map { |record| accessors.size > 1 ? Array(accessors).map { |accessor| record.public_send(accessor) } : record.public_send(accessors.first) }
+      map { |record| Array(accessors).map { |accessor| record.public_send(accessor) } }.map { |array| array.size == 1 ? array.first : array }
     end
 
-    # symbol要素の定義があれば、symbol名 + ? でインスタンスが同一のものか判別するメソッドを定義
+    # Automatically these methods are defined in this version. This method is remained only for compatibility.
     def self.define_question_methods(attr_name = :symbol)
-      constants.collect { |name| const_get(name) }.each do |object|
+      unsorted_all.each do |object|
         define_method(object.public_send(attr_name).to_s + '?') { self == object } if object.respond_to?(attr_name)
       end
     end
 
-    # 定義したaccessorを順序を保ったまま保持したいためオーバーライド。従来のattr_accessorの挙動は変更しない。
+    # Wrap default attr_accessor method in order to save accessor defined order.
     def self.attr_accessor(*several_variants)
       @accessors = *several_variants
       super
     end
 
-    # accessor一覧を取得するメソッド
+    # Get accessors the overrided method saved.
     def self.accessors
       readers = instance_methods.reject { |attr| attr.to_s[-1] == '=' }
       writers = instance_methods.select { |attr| attr.to_s[-1] == '=' }.map { |attr| attr.to_s.chop.to_sym }
@@ -53,40 +84,53 @@ module ActiveValue
       Array(@accessors) | accessors.reverse!
     end
 
-    # ActiveRecordのnewのようにハッシュで初期化を行える機能と
-    # コピーコンストラクタ(に似た何か)を定義(Shallowコピー)
+    # Wrapper dup method for can't dup on Fixnum#dup (NilClass etc.) before Ruby 2.4
+    def self.patched_dup(object)
+      object.dup
+    rescue TypeError
+      object
+    end
+
+    # If self instance is passed as an argument, create a new instance that has copied attributes. (it's like copy constructor by shallow copy)
+    # Hash instance is passed, the hash attributes apply a new instance.
     def initialize(attributes = {})
       case attributes
-      when self.class then self.class.accessors.stringify_keys.each { |attribute| public_send(attribute + '=', attributes.public_send(attribute)) }
+      when self.class then self.class.accessors.map(&:to_s).each { |attribute| public_send(attribute + '=', attributes.public_send(attribute)) }
       when Hash       then attributes.stringify_keys.each { |key, value| public_send(key + '=', value) if respond_to?(key + '=') }
       end
     end
 
-    # ActiveRecordと同様に要素へハッシュアクセスで取得できるようにアクセサを定義
-    #def [](attribute);         public_send(attribute);                  end
-    #def []=(attribute, value); public_send(attribute.to_s + '=', value) end
+    # If objects have symbol attributes, the objects can be checked equivalence by the method named symbol + `?`
+    def method_missing(method, *args, &block)
+      object = self.class.unsorted_all.find { |object| object.respond_to?(:symbol) && method.to_s == object.public_send(:symbol).to_s + '?' }
+      if object.nil?
+        super
+      else
+        self == object
+      end
+    end
 
-    # Hash型へ浅い変換を行う。値がコンテナ(Hash, Array)を含んでいた場合もその中の探索は行わずそのまま出力をする。
+    # Convert to hash with shallow copy. If values include collections(Hash, Array, etc.), search and convert without elements of the collection.
     def to_shallow_hash
-      self.class.accessors.inject(Hash.new) { |hash, key| hash[key] = public_send(key); hash }.reject { |key, value| value.nil? }
+      self.class.accessors.each_with_object({}) { |key, hash| hash[key] = self.class.patched_dup(public_send(key)) }
     end
 
-    # Hash型へ深い変換を行う。値がコンテナ(Hash, Array)を含んでいた場合、このクラスが含まれなくなるまで探索とHashへの変換を再帰的に行う。
+    # Convert to hash with deep copy. If values include collections(Hash, Array, etc.), search and convert into collections recursively.
     def to_deep_hash
       scan = ->(value) do
         case value
-        when Hash           then value.inject(Hash.new) { |h, (k, v)| h[k] = scan.call(v); h }
-        when Array          then value.map { |v| scan.call(v) }
-        when ConstantRecord then scan.call(value.to_shallow_hash)
-        else value
+        when Hash  then value.each_with_object({}) { |(k, v), h| h[k] = scan.call(v) }
+        when Array then value.map { |v| scan.call(v) }
+        when Base  then scan.call(value.to_shallow_hash)
+        else self.class.patched_dup(value)
         end
       end
-      self.class.accessors.inject(Hash.new) { |hash, key| hash[key] = scan.call(public_send(key)); hash }
+      self.class.accessors.each_with_object({}) { |key, hash| hash[key] = scan.call(public_send(key)) }
     end
     alias_method :to_h, :to_deep_hash
 
     def to_json
-      to_h.to_json
+      JSON.generate(to_h)
     end
 
     def inspect
@@ -94,11 +138,21 @@ module ActiveValue
       Hash === hash ? '#<' << self.class.name.split('::').last << ' ' << hash.map { |key, value| key.to_s << ': ' << value.inspect }.join(', ') << '>' : hash.inspect
     end
 
-    # Spaceship Operatorを定義、id等の比較可能な識別子が最初に定義されることが前提、存在しなければobject_idを参照する。
-    # TODO: ソート順序の基準となるattrの宣言を行うメソッドの実装
+    # Define the equal operator. `A == B` expression means every attribute has same value. (NOT object_id comparison)
+    def ==(another)
+      self.class.accessors.all? { |attr| public_send(attr) == another.public_send(attr) }
+    end
+    alias_method :eql?, :==
+
+    # Hash method for equivalence comparison with `eql?` method. (Referenced by `Enumerable#uniq` method etc.)
+    def hash
+      to_json.hash
+    end
+
+    # Define the spaceship operator. Compare self with another by the first defined accessor. (In many cases, it's `id` implicitly)
     def <=>(another)
       attr = self.class.accessors.first || :object_id
-      public_send(attr) <=> another.public_send(attr)
+      public_send(attr) <=> another.public_send(attr) if respond_to?(attr) && another.respond_to?(attr)
     end
 
   end

data/lib/active_value/version.rb

@@ -1,3 +1,3 @@
 module ActiveValue
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,78 +1,81 @@
 --- !ruby/object:Gem::Specification
 name: active_value
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Taiki Hiramatsu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: 5.2.4
+description: In a class inherited this class, constant variables get the behavior
+  like records of ActiveRecord.
 email:
-- ta.hi.samba@gmail.com
+- info@hiramatsu-sa-office.jp
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/publish.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -88,8 +91,7 @@ files:
 homepage: https://github.com/hiratai/active_value
 licenses:
 - MIT
-metadata:
-  allowed_push_host: https://rubygems.org
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -98,15 +100,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: Model for non database.(ValueObject) However like ActiveRecord.
+summary: ActiveValue is base class for immutable value object that has interfaces
+  like ActiveRecord.
 test_files: []