rekkyo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43c12110a7a3b05da0003a83490ba9a28e38117331ded44d254ed6850bd59eb8
+  data.tar.gz: 39b797a2e7859ae7d10e3257ba327128a3ed581621423bd3d3a4d87435a33cb7
+SHA512:
+  metadata.gz: 2bf129aaa32a96d1835d7bf9c63b319bf281266f006105ff5b81b05115103918bdf02bf4a3e685453fdd6a24ec9128d510d7771c584dec0a3cec25e89bd3014e
+  data.tar.gz: 977c624bd77a82f3e5359cdc30f85ff47f70dcdacada4e4e99fe0a024fc613da88c0c48d63fbd3510c9b87df8684f8d172da699d17ac0b9cfe1d603f262cb6a7

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/EndOfLine:
+  Enabled: true
+  EnforcedStyle: lf
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Max: 128

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+  - 2.5.3
+gemfile:
+  - Gemfile
+  - gemfiles/activesupport_5.1.gemfile
+  - gemfiles/activesupport_5.2.gemfile
+before_install: gem install bundler -v 1.17.1

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## Unreleased
+
+
+## 0.1.0 (2018-12-07)
+
+Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Yuji Hanamura
+
+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,68 @@
+# Rekkyo
+
+[![Build Status](https://travis-ci.org/yujideveloper/rekkyo.svg?branch=master)](https://travis-ci.org/yujideveloper/rekkyo)
+[![Maintainability](https://api.codeclimate.com/v1/badges/37d6334cedf5b04af831/maintainability)](https://codeclimate.com/github/yujideveloper/rekkyo/maintainability)
+
+Rekkyo is a gem for defining an enumerated type in Ruby.
+
+This gem is inspired by [`Ruby::Enum`](https://github.com/dblock/ruby-enum) and [`Enum`](https://github.com/LIQIDTechnology/enum_class).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rekkyo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rekkyo
+
+## Usage
+
+### Basic usage
+
+``` ruby
+class Color
+  include Rekkyo::Type
+
+  member :RED
+  member :GREEN
+  member :BLUE
+end
+
+{ color: Color::RED }.to_json # => "{\"color\":\"RED\"}
+```
+
+### Custom value
+
+``` ruby
+class Color
+  include Rekkyo::Type
+
+  member :RED,   "#FF0000"
+  member :GREEN, "#00FF00"
+  member :BLUE,  "#0000FF"
+end
+
+{ color: Color::RED }.to_json # => "{\"color\":\"#FF0000\"}"
+```
+
+## 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/yujideveloper/rekkyo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rekkyo"
+
+require "pry"
+Pry.start

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/activesupport_5.1.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org/"
+
+gem "activesupport", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/activesupport_5.2.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org/"
+
+gem "activesupport", "~> 5.2.0"
+
+gemspec path: "../"

data/lib/rekkyo.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rekkyo/version"
+
+module Rekkyo
+  class Error < StandardError; end
+  class DuplicateMemberError < Error
+  end
+end
+
+require "rekkyo/type"

data/lib/rekkyo/type.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "set"
+
+module Rekkyo
+  module Type
+    Member = Struct.new(:key, :value) do
+      def match?(value)
+        if value.is_a? self.class
+          self == value
+        else
+          self.value == value
+        end
+      end
+
+      def to_s
+        self.value.to_s
+      end
+
+      if defined? ActiveSupport
+        def as_json(options = nil)
+          self.to_s.as_json(options)
+        end
+      end
+    end
+
+    class << self
+      def included(klass)
+        klass.const_set(:Member, Class.new(Member))
+        klass.instance_variable_set(:@members, Set.new)
+        klass.extend(ClassMethods)
+      end
+    end
+
+    module ClassMethods
+      UNSPECIFIED = Object.new.freeze
+      private_constant :UNSPECIFIED
+
+      def member(key, value = UNSPECIFIED)
+        value = key if value == UNSPECIFIED
+        key = key.upcase.to_sym
+
+        raise DuplicateMemberError if self.const_defined?(key, false) ||
+                                      @members.any? { |m| m.match? value }
+
+        m = self::Member.new(key, value).freeze
+        @members << m
+        self.const_set(key, m)
+      end
+
+      def all
+        @members.dup
+      end
+
+      alias members all
+    end
+  end
+end

data/lib/rekkyo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rekkyo
+  VERSION = "0.1.0"
+end

data/rekkyo.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rekkyo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rekkyo"
+  spec.version       = Rekkyo::VERSION
+  spec.authors       = ["Yuji Hanamura"]
+  spec.email         = ["yuji.developer@gmail.com"]
+
+  spec.summary       = "An enumerated type in Ruby."
+  spec.description   = "Rekkyo is a gem for defining an enumerated type in Ruby."
+  spec.homepage      = "https://github.com/yujideveloper/rekkyo"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/yujideveloper/rekkyo/tree/master/CHANGELOG.md"
+
+  # 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(__dir__)) 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", "~> 1.17"
+  spec.add_development_dependency "pry", ">= 0.12.2"
+  spec.add_development_dependency "pry-doc", ">= 0.13.5"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rubocop", ">= 0.61.1"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: rekkyo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Hanamura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-07 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+- !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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.61.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.61.1
+description: Rekkyo is a gem for defining an enumerated type in Ruby.
+email:
+- yuji.developer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/activesupport_5.1.gemfile
+- gemfiles/activesupport_5.2.gemfile
+- lib/rekkyo.rb
+- lib/rekkyo/type.rb
+- lib/rekkyo/version.rb
+- rekkyo.gemspec
+homepage: https://github.com/yujideveloper/rekkyo
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yujideveloper/rekkyo
+  source_code_uri: https://github.com/yujideveloper/rekkyo
+  changelog_uri: https://github.com/yujideveloper/rekkyo/tree/master/CHANGELOG.md
+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.7.6
+signing_key: 
+specification_version: 4
+summary: An enumerated type in Ruby.
+test_files: []