swifty_enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7b37736e962e666fac20dde01e00d94c34a421e
+  data.tar.gz: f1be1fa88e133483eb4affa4393f0ac89576fd4e
+SHA512:
+  metadata.gz: daa3d52ab3e1d5ab6b2c49f47087473f4319346ebd78160187a8148af6a455bb9d3cfe4164a9fcc422d0cf346dd1710f2b493c2c5c1252db5886ade5221c3e62
+  data.tar.gz: d4dc35932be33c9d749114da3ab124c668c3664c84820e70ee11151efe6a89932adace51a3c12d3a6d8d9eb15e1c44fcd60d0bdcd5601e979e09cda7ab9c9429

data/.gitignore

@@ -0,0 +1,56 @@
+
+# Created by https://www.gitignore.io/api/ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# End of https://www.gitignore.io/api/ruby

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,48 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                    { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end
+
+guard :yard do
+  watch(%r{app/(.*/)?([^/]+)\.rb})
+  watch(%r{lib/(.*/)?([^/]+)\.rb})
+end
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 zeero
+
+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,103 @@
+# SwiftyEnum
+
+SwiftyEnum enable defining enums in Ruby. Enums behave like Swift enums.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swifty_enum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swifty_enum
+
+## Usage
+
+```ruby
+
+# Define enum class.
+class Flag
+
+  # Required: Include SwiftyEnum module.
+  include SwiftyEnum
+
+  # Now you can define enum case by 'def_case' statement.
+  #   Usage: def_case CASE_NAME [RAWVALUE]
+  def_case 'On', '1'
+  def_case 'Off', '0'
+
+  # You can also define method for each enum cases by 'def_method' statement.
+  # Please put this statement below all of 'def_case' statements.
+  #   Usage: def_method METHOD_NAME { || ... }
+  def_method 'status' do |enum_case|
+    case enum_case
+    when Flag::On then
+      # You can't use return statement, but value of last statement is returned from enum method.
+      'OK'
+    when Flag::Off then
+      'NG'
+    end
+  end
+end
+
+
+# Enum case is defined as subclass.
+Flag::On                       # => Flag::On
+
+# Enum case has class method 'hashvalue'.
+# It is incremental value by enum case definition.
+Flag::On.hashvalue             # => 0
+
+# Enum case has class method 'rawvalue'.
+# If rawvalue is not given in definition, hashvalue is used instead.
+Flag::On.rawvalue              # => '1'
+
+# Enum case can be gotten by 'get' method with rawvalue.
+Flag.get('1')                  # => Flag::On
+Flag.get('0')                  # => Flag::Off
+
+# If invalid rawvalue is given, 'get' method returns nil.
+Flag.get('2')                  # => nil
+
+# Enum case can be handled with case-when statement.
+on = Flag.get('1')
+case on
+when Flag::Off then
+  puts 'NG'
+when Flag::On then
+  puts 'OK'
+else
+  puts 'NG'
+end
+# >> OK
+
+# Enum method is defined in each enum cases.
+Flag::On.status                # => 'OK'
+Flag::Off.status               # => 'NG'
+
+# When you want to get all of enum cases, use 'enum_cases'.
+Flag.enum_cases                # => [Flag::On, Flag::Off]
+
+```
+
+## 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/zeero/ruby-swifty_enum.
+
+## 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 "swifty_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,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/lib/swifty_enum/messages.rb

@@ -0,0 +1,7 @@
+module SwiftyEnum
+  module Messages
+    ERR_DUPLICATE_ENUM_RAWVALUE  = 'error: enum rawvalue "%s" has already defined'
+    ERR_DEF_METHOD_WITHOUT_BLOCK = 'error: "def_method" needs block'
+    ERR_DEF_METHOD_FOR_EMPTY     = 'error: you trying to define enum method, but there is no defined enum case'
+  end
+end

data/lib/swifty_enum/version.rb

@@ -0,0 +1,3 @@
+module SwiftyEnum
+  VERSION = "0.1.0"
+end

data/lib/swifty_enum.rb

@@ -0,0 +1,81 @@
+# Module to be included in enum class.
+#
+# @author zeero
+
+require "swifty_enum/version"
+require "swifty_enum/messages"
+
+module SwiftyEnum
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+  
+  module ClassMethods
+
+    # define enum case as subclass
+    # @param [String] name     enum case name
+    # @param [Object] rawvalue enum case rawvalue
+    # @raise [RuntimeError] SwiftyEnum::Messages::ERR_DUPLICATE_ENUM_RAWVALUE
+    def def_case(name, rawvalue = nil)
+      @_enum_hash ||= {}
+      hashvalue = @_enum_hash.size
+      rawvalue ||= hashvalue
+
+      # check rawvalue is unique
+      if @_enum_hash.has_key? rawvalue
+        raise sprintf(SwiftyEnum::Messages::ERR_DUPLICATE_ENUM_RAWVALUE, rawvalue)
+      end
+
+      klass = Class.new
+      klass.define_singleton_method 'hashvalue' do
+        return hashvalue
+      end
+      klass.define_singleton_method 'rawvalue' do
+        return rawvalue
+      end
+      klass.define_singleton_method '===' do |rhs|
+        return klass == rhs
+      end
+      const_set :"#{name}", klass
+
+      @_enum_hash[rawvalue] = klass
+    end
+
+    # define enum method
+    # @param [String] name enum method name
+    def def_method(name)
+      @_enum_hash ||= {}
+
+      # check block given
+      if ! block_given?
+        raise SwiftyEnum::Messages::ERR_DEF_METHOD_WITHOUT_BLOCK
+      end
+
+      # check defined enum case existing
+      if @_enum_hash.empty?
+        raise SwiftyEnum::Messages::ERR_DEF_METHOD_FOR_EMPTY
+      end
+
+      @_enum_hash.values.each do |klass|
+        klass.define_singleton_method name do
+          yield klass
+        end
+      end
+    end
+
+    # get enum case
+    # @param  [Object] rawvalue enum case rawvalue
+    # @return [Class]  enum case
+    def get(rawvalue)
+      @_enum_hash ||= {}
+      return @_enum_hash.fetch rawvalue, nil
+    end
+
+    # get all enum cases
+    # @return [Array] enum cases
+    def enum_cases
+      return @_enum_hash.values
+    end
+  end
+end
+

data/swifty_enum.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swifty_enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swifty_enum"
+  spec.version       = SwiftyEnum::VERSION
+  spec.authors       = ["zeero"]
+  spec.email         = ["zeero26@gmail.com"]
+
+  spec.summary       = %q{Enum for Ruby with Swift style.}
+  spec.description   = %q{SwiftyEnum enable defining enums in Ruby. Enums behave like Swift enums.}
+  spec.homepage      = "https://github.com/zeero/ruby-swifty_enum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-doc_reporter"
+  spec.add_development_dependency "minitest-stub_any_instance"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "guard-yard"
+  spec.add_development_dependency "rb-fsevent"
+  spec.add_development_dependency "terminal-notifier-guard", "~> 1.6.1"
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: swifty_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- zeero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-18 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: pry
+  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: 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: minitest-doc_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'
+- !ruby/object:Gem::Dependency
+  name: minitest-stub_any_instance
+  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: yard
+  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: guard
+  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: guard-minitest
+  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: guard-yard
+  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: rb-fsevent
+  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: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+description: SwiftyEnum enable defining enums in Ruby. Enums behave like Swift enums.
+email:
+- zeero26@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/swifty_enum.rb
+- lib/swifty_enum/messages.rb
+- lib/swifty_enum/version.rb
+- swifty_enum.gemspec
+homepage: https://github.com/zeero/ruby-swifty_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.5.1
+signing_key: 
+specification_version: 4
+summary: Enum for Ruby with Swift style.
+test_files: []