activerecord-enum_sti 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2864a486385e91036a6ea2b553456718d9c3314cc27bbabf677d834f0d8cf965
+  data.tar.gz: bc8cd160397908527f5feb5fae2b2dace8c3fc5cf2a4b297fe7842f9def2154f
+SHA512:
+  metadata.gz: 7dbe099d17b9af52ca7e7fd85709fabdc020e24894a2dd386756d449e599ab4651be32772e5f44ca347d499e9e51c05024239b86b84a5199d0df9723a5aef6e0
+  data.tar.gz: f069c2eb9f5204040c159199a0b02dfe5815c28147b49745e6133bba9ce2151200f461f1ed63a4dc2ddb431fa6b14e3b4c4e77246a976eb607255b956652bbb1

data/.github/workflows/ci.yaml

@@ -0,0 +1,37 @@
+name: CI
+on: [push]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.5'
+          - '2.6'
+          - '2.7'
+        rails:
+          - 'rails_5.2'
+          - 'rails_6.0'
+          - 'rails_edge'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Setup System
+        run: |
+          sudo apt-get install libsqlite3-dev
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Bundle
+        env:
+          MTSR_RAILS_VERSION: ${{ matrix.rails }}
+        run: |
+          export BUNDLE_GEMFILE="${GITHUB_WORKSPACE}/gemfiles/${MTSR_RAILS_VERSION}.gemfile"
+          bundle install --jobs 4 --retry 3
+      - name: Test
+        env:
+          MTSR_RAILS_VERSION: ${{ matrix.rails }}
+        run: |
+          export BUNDLE_GEMFILE="${GITHUB_WORKSPACE}/gemfiles/${MTSR_RAILS_VERSION}.gemfile"
+          bundle exec rake

data/.github/workflows/release.yaml

@@ -0,0 +1,18 @@
+name: release
+
+on:
+  push:
+    tags:
+      - v*
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Release Gem
+        if: contains(github.ref, 'refs/tags/v')
+        uses: cadwallion/publish-rubygems-action@master
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RELEASE_COMMAND: rake release

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+vendor
+*.gemfile.lock
+gemfiles/.bundle

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ksuzuki180@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in activerecord-enum_sti.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 suusan2go
+
+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,125 @@
+# ActiveaRecord::EnumSti ![CI](https://github.com/suusan2go/activerecord-enum_sti/workflows/CI/badge.svg)
+
+ActiveRecord::EnumSti is a library to use enum values as STI type.  
+
+When you use enum, you might see the code like following.
+
+```ruby
+class Payment < ApplicationRecord
+  enum kind: { credit_card: 0, bank_transfer: 10, paypal: 20 }
+
+  def complete!
+    if credit_card?
+    # do something
+    elsif bank_transfer?
+    # do something
+    elsif paypal?
+    # do something
+    end
+  end
+
+  def cancel!
+    if credit_card?
+    # do something
+    elsif bank_transfer?
+    # do something
+    elsif paypal?
+    # do something
+    end
+  end
+end
+```
+
+In this code, we change the behavior according to the value of enum.
+But if we can change the class by the value of enum, this code will be more clear.
+
+This gem allows you to split the class using the Single Table Inheritance (STI) in Rails depending on the value of the enum.
+
+```ruby
+class Payment < ApplicationRecord
+  include ActiveRecord::EnumSti
+  enum type: { credit_card: 0, bank_transfer: 10, paypal: 20 }
+
+  def complete!
+    raise NotImplementedError
+  end
+
+  def cancel!
+    raise NotImplementedError
+  end
+end
+
+class Payment::CreditCard < Payment
+  def complete!
+    # do something for creditcard!
+  end
+
+  def cancel!
+    # do something for creditcard!
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-enum_sti'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-enum_sti
+
+## Usage
+First of all, include `ActiveRecord::EnumSti` in your enum defined class.
+
+```ruby
+class Payment < ApplicationRecord
+  include ActiveRecord::EnumSti
+  enum type: { credit_card: 0, bank_transfer: 10, paypal: 20 }
+  # if you want to use the another column, you can use another enum column by below.
+  # self.inheritance_column = :your_enum_column
+end
+```
+
+Then, please define a class for each enum values. The class name should be `<SuperClass>::<camelized enum value>`
+
+```ruby
+class Payment::CreditCard < Payment
+end
+```
+
+Now, you can use the value of enum for STI like below!
+
+```
+@credit_card = Payment::CreditCard.create
+@credit_card.type
+=> "credit_card"
+Payment::CreditCard.all.to_sql
+=> "SELECT \"payments\".* FROM \"payments\" WHERE \"payments\".\"type\" = 0"
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activerecord-enum_sti. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Activerecord::EnumSti project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/activerecord-enum_sti/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord-enum_sti.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record/enum_sti/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-enum_sti"
+  spec.version       = ActiveRecord::EnumSti::VERSION
+  spec.authors       = ["suusan2go"]
+  spec.email         = ["ksuzuki180@gmail.com"]
+
+  spec.summary       = %q{Use enum value as a STI type}
+  spec.description   = %q{This gem allows you to use enum value as a STI type value easily.}
+  spec.homepage      = "https://github.com/suusan2go/activerecord-enum_sti"
+  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"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/suusan2go/activerecord-enum_sti"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'sqlite3'
+
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'activerecord', '>= 5.2'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/enum_sti"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", github: "rails/rails", branch: "5-2-stable"
+
+gemspec :path => "../"

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", github: "rails/rails", branch: "6-0-stable"
+
+gemspec :path => "../"

data/gemfiles/rails_edge.gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+git "https://github.com/rails/rails.git", :branch => "master" do
+  gem "activerecord"
+end
+
+gemspec :path => "../"

data/lib/active_record/enum_sti.rb

@@ -0,0 +1,31 @@
+require "active_record/enum_sti/version"
+require "active_support/concern"
+require "active_support/core_ext/string/inflections"
+
+module ActiveRecord
+  module EnumSti
+    extend ActiveSupport::Concern
+
+    class Error < StandardError; end
+
+    class_methods do
+      def find_sti_class(type)
+        type_name = enum_items.key(type)
+        prefix = if superclass == ActiveRecord::Base || superclass.abstract_class
+                   name
+                 else
+                   superclass.name
+                 end
+        "#{prefix}::#{type_name.to_s.camelize}".constantize
+      end
+
+      def sti_name
+        enum_items[name.demodulize.underscore]
+      end
+
+      def enum_items
+        public_send(inheritance_column.pluralize)
+      end
+    end
+  end
+end

data/lib/active_record/enum_sti/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module EnumSti
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-enum_sti
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- suusan2go
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '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: rspec
+  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: sqlite3
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: This gem allows you to use enum value as a STI type value easily.
+email:
+- ksuzuki180@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yaml"
+- ".github/workflows/release.yaml"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-enum_sti.gemspec
+- bin/console
+- bin/setup
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_edge.gemfile
+- lib/active_record/enum_sti.rb
+- lib/active_record/enum_sti/version.rb
+homepage: https://github.com/suusan2go/activerecord-enum_sti
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/suusan2go/activerecord-enum_sti
+  source_code_uri: https://github.com/suusan2go/activerecord-enum_sti
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Use enum value as a STI type
+test_files: []