simpler_enum 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 852c5f27e0a8a5ad10d26623f91b83964f1e09e9
+  data.tar.gz: 77221d767767b7f3d8345be3a2ce3fb7d3b507bc
+SHA512:
+  metadata.gz: 29e8d3f065ca1d8a704f8c8e9918d0760219bf2b5b6a502683d77e8d0028d9f5bd62ad5afbac71a483c9101cb000d1213baacf67a2e6c1e1bdf422087a157cfd
+  data.tar.gz: e47c153ede0a48eb12f0164c38390cab04e98bda4bd18b56f2b80d27c537bad31fc230ffa5280e68bf15fac35c08e0a4bdec70ad58c12c0decc970501a8c4d4d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,50 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/*'
+
+# Accept single-line methods with no body
+SingleLineMethods:
+  AllowIfMethodIsEmpty: true
+
+# Top-level documentation of clases and modules are needless
+Documentation:
+  Enabled: false
+
+# Allow to chain of block after another block that spans multiple lines
+MultilineBlockChain:
+  Enabled: false
+
+# Allow `->` literal for multi line blocks
+Lambda:
+  Enabled: false
+
+# Both nested and compact are okay
+ClassAndModuleChildren:
+  Enabled: false
+
+# Specifying param names is unnecessary
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Prefer Kernel#sprintf
+FormatString:
+  EnforcedStyle: sprintf
+
+# Maximum line length
+LineLength:
+  Max: 100
+
+# Whatever we should use "postfix if/unless"
+IfUnlessModifier:
+  MaxLineLength: 100
+
+# Maximum method length
+MethodLength:
+  Max: 20
+
+# Prefer double_quotes strings unless your string literal contains escape chars
+StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simple_enum.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 necojackarc
+
+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,78 @@
+# SimplerEnum [![Build Status](https://travis-ci.org/necojackarc/simpler_enum.svg?branch=master)](https://travis-ci.org/necojackarc/simpler_enum) [![Code Climate](https://codeclimate.com/github/necojackarc/simpler_enum/badges/gpa.svg)](https://codeclimate.com/github/necojackarc/simpler_enum) [![Test Coverage](https://codeclimate.com/github/necojackarc/simpler_enum/badges/coverage.svg)](https://codeclimate.com/github/necojackarc/simpler_enum/coverage)
+
+SimplerEnum provides really simple enumerated type.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simpler_enum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simpler_enum
+
+## Usage
+
+Any class can include `SimplerEnum` and you can define an enumerated type like this:
+
+```ruby
+require "simpler_enum"
+
+class Person
+  include SimplerEnum
+
+  simpler_enum mood: {
+    awesome: 0,
+    excellent: 1,
+    great: 2,
+    good: 3,
+    fine: 4
+  }
+
+  def initialize(mood: :fine)
+    self.mood = mood
+  end
+end
+```
+
+```ruby
+[1] pry(main)> Person.moods
+=> {:awesome=>0, :excellent=>1, :great=>2, :good=>3, :fine=>4}
+[2] pry(main)> necojackarc = Person.new(mood: :awesome)
+=> #<Person:0x007fd5cbbf5dd0 @mood=0>
+[3] pry(main)> necojackarc.awesome?
+=> true
+[4] pry(main)> necojackarc.excellent?
+=> false
+[5] pry(main)> necojackarc.great!
+=> :great
+[6] pry(main)> necojackarc.awesome?
+=> false
+[7] pry(main)> necojackarc.great?
+=> true
+[8] pry(main)> necojackarc.mood = :fine
+=> :fine
+[9] pry(main)> necojackarc.great?
+=> false
+[10] pry(main)> necojackarc.fine?
+=> true
+[11] pry(main)> necojackarc.mood = 1
+=> 1
+[12] pry(main)> necojackarc.fine?
+=> false
+[13] pry(main)> necojackarc.excellent?
+=> true
+[14] pry(main)> necojackarc.mood
+=> :excellent
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_enum"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simpler_enum.rb

@@ -0,0 +1,69 @@
+require "active_support"
+require "active_support/core_ext"
+require "simpler_enum/version"
+
+module SimplerEnum
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def simpler_enum(single_size_hash)
+      fail ArgumentError if single_size_hash.size != 1
+
+      name, enum_values = single_size_hash.first
+
+      define_read_enum_values_method_to_class!(name.to_s.pluralize, enum_values)
+      define_read_enum_value_method_to_instance!(name)
+      define_write_enum_value_method_to_instance!(name)
+
+      enum_values.each do |key, _|
+        define_query_enum_state_method_to_instance!(name, key)
+        define_change_enum_state_method_to_instance!(name, key)
+      end
+    end
+
+    private
+
+    def define_read_enum_values_method_to_class!(pluralized_name, enum_values)
+      instance_variable_set("@#{pluralized_name}", enum_values)
+      define_singleton_method pluralized_name do
+        instance_variable_get "@#{pluralized_name}"
+      end
+    end
+
+    def define_query_enum_state_method_to_instance!(enum_name, value_name)
+      define_method "#{value_name}?" do
+        current_value = instance_variable_get("@#{enum_name}")
+        current_value == self.class.public_send(enum_name.to_s.pluralize.to_sym)[value_name]
+      end
+    end
+
+    def define_change_enum_state_method_to_instance!(enum_name, value_name)
+      define_method "#{value_name}!" do
+        next_value = self.class.public_send(enum_name.to_s.pluralize.to_sym)[value_name]
+        instance_variable_set("@#{enum_name}", next_value)
+        public_send(enum_name)
+      end
+    end
+
+    def define_read_enum_value_method_to_instance!(enum_name)
+      define_method "#{enum_name}" do
+        value = instance_variable_get("@#{enum_name}")
+        self.class.public_send(enum_name.to_s.pluralize.to_sym).key(value)
+      end
+    end
+
+    def define_write_enum_value_method_to_instance!(enum_name)
+      define_method "#{enum_name}=" do |value|
+        next_value =
+          if value.is_a?(Symbol)
+            self.class.public_send(enum_name.to_s.pluralize.to_sym)[value]
+          else
+            value
+          end
+        instance_variable_set("@#{enum_name}", next_value)
+      end
+    end
+  end
+end

data/lib/simpler_enum/version.rb

@@ -0,0 +1,3 @@
+module SimplerEnum
+  VERSION = "0.1.1"
+end

data/simpler_enum.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simpler_enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simpler_enum"
+  spec.version       = SimplerEnum::VERSION
+  spec.authors       = ["necojackarc"]
+  spec.email         = ["necojackarc@gmail.com"]
+
+  spec.summary       = %q{Simpler Enumerated Type}
+  spec.description   = %q{simpler_enum provides really simple enumerated type}
+  spec.homepage      = "https://github.com/necojackarc/simpler_enum"
+  spec.license       = "MIT"
+
+  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.add_dependency "activesupport"
+  spec.add_dependency "i18n"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: simpler_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- necojackarc
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-10 00:00:00.000000000 Z
+dependencies:
+- !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: i18n
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: simplecov
+  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: codeclimate-test-reporter
+  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: simpler_enum provides really simple enumerated type
+email:
+- necojackarc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simpler_enum.rb
+- lib/simpler_enum/version.rb
+- simpler_enum.gemspec
+homepage: https://github.com/necojackarc/simpler_enum
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Simpler Enumerated Type
+test_files: []