enumerated_constants 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44ab6d4867d93badb655b39ecbca2fd3d3d0bb5a
+  data.tar.gz: 9483db69633e0b8b065ff632354dbd1da2914b38
+SHA512:
+  metadata.gz: 33f0c13df731bbb3ba064fb3f256fa949426a1f92d2338f6f7be7967b9844d3cb1a21458b33cb1688339cdd88f9fa05863486dfd7d7d00d7914811bc9c64adb1
+  data.tar.gz: 063bf6d0cfed53bb21ae1f2eb081b77039f99d68d5558c26173673f743f636c416564628e134bb85722d60512da918c88b758a5fa74185625281b2c0f0ac4eaa

data/.gitignore

@@ -0,0 +1 @@
+/Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

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, 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 enumerated_constants.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Apartment List
+
+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,132 @@
+[![Build Status](https://travis-ci.org/apartmentlist/enumerated_constants.svg?branch=master)](https://travis-ci.org/apartmentlist/enumerated_constants)
+
+# EnumeratedConstants
+
+Emulate the handy enum seen in other programming languages
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enumerated_constants'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enumerated_constants
+
+## Usage
+
+Include `EnumeratedConstants` in a module that defines a set of related constants, e.g.
+
+```
+require 'enumerated_constants'
+
+class User
+  attr_accessor :role
+
+  module Role
+    include EnumeratedConstants
+
+    ADMIN   = 'admin'.freeze
+    MANAGER = 'manager'.freeze
+    GUEST   = 'guest'.freeze
+
+    PRIVILEGED = [ADMIN, MANAGER].freeze
+  end
+
+  def validate_role!
+    unless Role.include?(self.role)
+      raise "Invalid role, expecting one of #{Role.all.join(', ')}"
+    end
+  end
+end
+```
+
+## Available methods
+
+### `all`
+Return all constant values in the module that are not `Array`s.
+
+```ruby
+User::Role.all
+# => ["admin", "manager", "guest"]
+```
+
+### `each`
+Iterate through each constant value returned by `all`
+
+```ruby
+User::Role.each do |role|
+  puts role
+end
+# "admin"
+# "manager"
+# "guest"
+```
+
+### `except`
+Return all constants values except for the ones passed in. Note, the arguments should be
+the name of the constants, not the constants' value.
+
+```ruby
+User::Role.except(:guest)
+# => ["admin", "manager"]
+```
+
+### `include?`
+Return true if the value passed in is a value of one of the constants in the module
+
+```ruby
+User::Role.include?('guest')
+# => true
+User::Role.include?('hacker')
+# => false
+```
+
+### `map`
+Map the values of the module to other values
+
+```ruby
+User::Role.map { |role| "#{role} user" }
+# => ["admin user", "manager user", "guest user"]
+```
+
+### `sample`
+Randomly select value(s) from the module
+
+```ruby
+User::Role.sample
+# => "guest"
+User::Role.sample
+# => "admin"
+User::Role.sample(2)
+# => ["manager", "admin"]
+```
+
+### `sort`
+Return the sorted constant values
+
+```ruby
+User::Role.sort
+# => ["admin", "guest", "manager"]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/enumerated_constants/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+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 "enumerated_constants"
+
+# 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/enumerated_constants.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "enumerated_constants"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Tom Collier"]
+  spec.email         = ["collier@apartmentlist.com"]
+
+  spec.summary       = "Ruby mix-in that emulates the classic 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_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/enumerated_constants.rb

@@ -0,0 +1,33 @@
+require 'active_support/concern'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/inclusion'
+
+module EnumeratedConstants
+  extend ActiveSupport::Concern
+
+  # Methods added to the class upon include
+  module ClassMethods
+    def all
+      @all ||= constants.map(&method(:const_get)).delete_if do |constant|
+        constant == ClassMethods || constant.is_a?(Array)
+      end.freeze
+    end
+
+    delegate :each, :include?, :map, :sample, :sort, to: :all
+
+    # Return all but the constant name you pass
+    # @param name [Symbol,String] The name of the constant you don't want
+    # @return [Array] @all except the value of that constant
+    def except(*names)
+      const_names =
+      names = names.map(&:upcase).map(&:to_sym)
+      values = names.map do |name|
+        begin
+          const_get(name)
+        rescue NameError
+        end
+      end.compact
+      all - values
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: enumerated_constants
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Collier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-09 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: 
+email:
+- collier@apartmentlist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- enumerated_constants.gemspec
+- lib/enumerated_constants.rb
+homepage: 
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby mix-in that emulates the classic enum
+test_files: []
+has_rdoc: