case_register 0.0.1

data/.travis.yml

@@ -0,0 +1,29 @@
+sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=2f9bf253ef3487d24d1028eaee27bb105be5c5c31815749606612522a4ff1647
+language: ruby
+rvm:
+  - 2.2
+  - 2.6
+  - 2.7
+gemfile:
+  - gemfiles/Gemfile
+matrix:
+  include:
+    - dist: trusty
+      rvm: 1.8.7
+      gemfile: gemfiles/ruby_1_8_7.gemfile
+before_install:
+  - if `ruby -e 'exit(RUBY_VERSION.to_f < 2.7)'`; then
+      gem i rubygems-update -v '< 3' && update_rubygems;
+      gem install bundler -v '< 2';
+    fi
+  - gem --version
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake test
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1 @@
+## Change Log

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mrtmrt15xn@yahoo.com.tw. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Rumble Huang
+
+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,171 @@
+# CaseRegister
+
+[![Gem Version](https://img.shields.io/gem/v/case_register.svg?style=flat)](http://rubygems.org/gems/case_register)
+[![Build Status](https://travis-ci.com/khiav223577/case_register.svg?branch=master)](https://travis-ci.org/khiav223577/case_register)
+[![RubyGems](http://img.shields.io/gem/dt/case_register.svg?style=flat)](http://rubygems.org/gems/case_register)
+[![Code Climate](https://codeclimate.com/github/khiav223577/case_register/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/case_register)
+[![Test Coverage](https://codeclimate.com/github/khiav223577/case_register/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/case_register/coverage)
+
+## Supports
+- Ruby 1.8 ~ 2.7
+
+## Installation
+
+```ruby
+gem 'case_register'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install case_register
+
+## Usage
+
+### Refactor case statements
+
+Take the examples from this [article](http://bobnadler.com/articles/2010/08/02/refactoring-case-statements-in-ruby.html). Let you have a method like this:
+
+```rb
+def output(data, format)
+  case format
+  when :html
+    return "<p>#{data}</p>"
+  when :text
+    return data
+  when :pdf
+    return "<pdf>#{data}</pdf>" # pseudocode -- obviously not valid PDF output
+  else
+    raise ArgumentError, "Invalid format (#{format})."
+  end
+end
+
+output('Hi', :html)
+# => "<p>Hi</p>"
+```
+
+You can refactor it by using a hash table to map the input, like what the article says.
+
+Or use `CaseRegister` to register cases. Then, you are able to invoke the case directly without using switch-statements. 
+```rb
+class MyFormatter
+  include CaseRegister
+
+  def initialize(text)
+    @text = text
+  end
+
+  register_case(:pdf){ "<pdf>#{@text}</pdf>" }
+  register_case(:text){ @text }
+  register_case(:html){ "<p>#{@text}</p>" }
+end
+
+MyFormatter.new('Hi').invoke_case(:html)
+# => "<p>Hi</p>"
+``` 
+
+### Isolate methods
+
+Let you have an api that allow the frontend to pass params to determetine which information it wants.
+
+Since you have to use `send` to call the methods in user model dynamically, it will cause security issues if you do not use a whitelist to limit the methods it can access.   
+
+```rb
+class User < ApplicationRecord
+  def money_info
+    { value: money, rate: gain_money_rate }
+  end
+
+  def notification_info
+    { msg_count: new_msgs_count, last_recieved_at: last_recieved_at }
+  end
+end
+
+class UserController
+  METHOD_WHITE_LIST = [:money_info, :notification_info]
+ 
+  def refresh
+    result = params[:needs].slice(METHOD_WHITE_LIST).index_with{|method| current_user.send(method)  }
+    render json: result 
+  end
+end
+```
+
+You may use if-statements or switch-statments to map the input to the desired method. But you will find you repeat writing similiar things and it seems redundant.
+
+```rb
+class UserController
+  def refresh
+    result = {}
+    result[:money_info] = current_user.money_info if params[:needs][:money_info]
+    result[:notification_info] = current_user.notification_info if params[:needs][:notification_info]
+    # ...
+
+    render json: result 
+  end
+end
+```
+
+In this case, you can use `CaseRegister` to DRYing up and isolate the methods to prevent unsafely calling `send`, which can access all the methods defined in the model.
+
+```rb
+class RefreshHelper
+  include CaseRegister
+
+  def initialize(user)
+    @user = user
+  end
+
+  register_case 'money_info' do
+    { value: @user.money, rate: @user.gain_money_rate }
+  end
+
+  register_case 'notification_info' do
+    { msg_count: @user.new_msgs_count, last_recieved_at: @user.last_recieved_at }
+  end
+end
+
+class UserController
+  def refresh
+    helper = RefreshHelper.new(current_user)
+    result = params[:needs].index_with{|need| helper.invoke_case(need) }
+    render json: result 
+  end
+end
+```
+
+### Check if a case is registered
+
+Something, you may want to check if a case is valid or not, and return error message if not.
+
+It can be accomplish by using `may_invoke_case?` method. See the following example:
+
+```rb
+class UserController
+  def refresh
+    helper = RefreshHelper.new(current_user)
+    invalid_needs = params[:needs].select{|need| !helper.may_invoke_case?(need) }
+    return render json: { invalid_needs: invalid_needs } if invalid_needs.any?
+    # ...
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/khiav223577/case_register. 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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'case_register'
+
+# 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

data/bin/setup

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

data/case_register.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'case_register/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'case_register'
+  spec.version       = CaseRegister::VERSION
+  spec.authors       = ['khiav reoy']
+  spec.email         = ['mrtmrt15xn@yahoo.com.tw']
+
+  spec.summary       = 'Provide a design pattern to manage large switch statements by mapping it to methods.'
+  spec.description   = 'Provide a design pattern to manage large switch statements by mapping it to methods.'
+  spec.homepage      = 'https://github.com/khiav223577/case_register'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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{|f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}){|f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.metadata      = {
+    'homepage_uri'      => 'https://github.com/khiav223577/case_register',
+    'changelog_uri'     => 'https://github.com/khiav223577/case_register/blob/master/CHANGELOG.md',
+    'source_code_uri'   => 'https://github.com/khiav223577/case_register',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/case_register',
+    'bug_tracker_uri'   => 'https://github.com/khiav223577/case_register/issues',
+  }
+
+  spec.add_development_dependency 'bundler', '>= 1.17', '< 3.x'
+  spec.add_development_dependency 'rake', '>= 10.5.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/gemfiles/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_or.gemspec
+
+group :test do
+  gem 'simplecov'
+end
+
+gemspec :path => '../'

data/gemfiles/ruby_1_8_7.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_or.gemspec
+
+group :test do
+  gem 'simplecov'
+  gem 'minitest', '~> 5.11.3'
+end
+
+gemspec :path => '../'

data/lib/case_register.rb

@@ -0,0 +1,43 @@
+require 'case_register/version'
+
+module CaseRegister
+  def self.included(klass)
+    type_hash = {}
+    type_counter = 0
+
+    get_method_name = proc do |type|
+      next nil if type_hash == nil
+      next type_hash[type]
+    end
+
+    gen_method_name = proc do |type|
+      id = type_counter += 1
+      next (type_hash[type] = :"case_register_auto_method_name#{id}")
+    end
+
+    klass.extend(
+      Module.new do
+        define_method(:case_register_get_method_name){|type| get_method_name[type] }
+        define_method(:case_register_gen_method_name){|type| gen_method_name[type] }
+
+        def register_case(type, &block)
+          method_name = case_register_gen_method_name(type)
+          define_method(method_name, &block)
+          private(method_name)
+          return method_name
+        end
+      end
+    )
+  end
+
+  def invoke_case(type, *args)
+    method_name = self.class.case_register_get_method_name(type)
+
+    fail "Undefined case `#{type}` for #{self.class}" if method_name == nil
+    return send(method_name, *args)
+  end
+
+  def may_invoke_case?(type)
+    self.class.case_register_get_method_name(type) != nil
+  end
+end

data/lib/case_register/version.rb

@@ -0,0 +1,3 @@
+module CaseRegister
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: case_register
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- khiav reoy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.x
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.x
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.5.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'
+description: Provide a design pattern to manage large switch statements by mapping
+  it to methods.
+email:
+- mrtmrt15xn@yahoo.com.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- case_register.gemspec
+- gemfiles/Gemfile
+- gemfiles/ruby_1_8_7.gemfile
+- lib/case_register.rb
+- lib/case_register/version.rb
+homepage: https://github.com/khiav223577/case_register
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/khiav223577/case_register
+  changelog_uri: https://github.com/khiav223577/case_register/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/khiav223577/case_register
+  documentation_uri: https://www.rubydoc.info/gems/case_register
+  bug_tracker_uri: https://github.com/khiav223577/case_register/issues
+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: Provide a design pattern to manage large switch statements by mapping it
+  to methods.
+test_files: []