human_enum 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 580a579c699aa8bbe27b029de308d416b9ccb9d2
-  data.tar.gz: 6cc7d98306aa7b63390a7280e6a8aff84ef99593
+SHA256:
+  metadata.gz: 754cd01c0e5f2c7176d6cb835ee43cbbf555433f3b94f6d87c9762ca8a4091a5
+  data.tar.gz: ea1fa8588c89b94387dcb3df06e254041dc986832859e82b085d4bfb0e6dd93f
 SHA512:
-  metadata.gz: 980efea425a79ac105db4e38d142d1a76e7731e1c6fe060802f0d3c0393726846be59b9793d0334601d22bbaa904b995e4279af961f9b28d90933c6844511157
-  data.tar.gz: c36a21fdecf0f2dcaf11d0af8b5b88ea99e6f9b0fbd192df6eed62684c2babcf709da342601b91284d8d715d35b05e0d0cb9befb60b858c0e04ccc95ef5c3b72
+  metadata.gz: f28aa6018ef05d2bb2a8e745d919760ab4375c0f3056796cdd82903b5b3d1270f8bf1f15176c70d1002def46f4401dd50aa6df9a4e7d6cb90b55554b95c2c733
+  data.tar.gz: 9a1d8bc8aa7d50fc72044159631eca687247899c9d763398e8f6446909ac4d48196b098120d8701067c8e28f79f549b1effb3e431b171984c05e8b86fad503cd

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: rafasoares # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.github/workflows/gempush.yml

@@ -0,0 +1,41 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
+        OWNER: rafasoares
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -10,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# rspec local configuration
+.rspec-local

data/.hound.yml

@@ -0,0 +1,2 @@
+rubocop:
+  version: 0.72.0

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.gemspec'
+    - 'spec/**/*.rb'

data/.ruby-gemset

@@ -0,0 +1 @@
+rafasoares-human_enum

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.4

data/.semaphore/semaphore.yml

@@ -0,0 +1,52 @@
+version: v1.0
+name: Human Enum
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+  containers:
+    - name: main
+      image: 'ruby:2.6.4'
+      env_vars:
+        - name: BUNDLER_VERSION
+          value: 2.0.2
+blocks:
+  - name: Setup
+    task:
+      jobs:
+        - name: bundle
+          commands:
+            - bundle install --deployment -j 4 --path vendor/bundle
+      prologue:
+        commands:
+          - checkout
+          - cache restore
+          - gem install bundler -v $BUNDLER_VERSION
+      epilogue:
+        on_pass:
+          commands:
+            - cache store
+  - name: Code scanning
+    task:
+      jobs:
+        - name: check style
+          commands:
+            - bundle exec rubocop
+      prologue:
+        commands:
+          - checkout
+          - cache restore
+          - gem install bundler -v $BUNDLER_VERSION
+          - bundle install --deployment --path vendor/bundle
+  - name: Unit tests
+    task:
+      prologue:
+        commands:
+          - checkout
+          - cache restore
+          - gem install bundler -v $BUNDLER_VERSION
+          - bundle install --deployment --path vendor/bundle
+      jobs:
+        - name: RSpec
+          commands:
+            - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.1.1
+Improvements to the gem (no code changes)
+
+## 0.1.0
+First version

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in human_enum.gemspec

data/Gemfile.lock

@@ -0,0 +1,119 @@
+PATH
+  remote: .
+  specs:
+    human_enum (0.1.1)
+      activerecord (> 5.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    guard (2.15.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    listen (3.2.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    minitest (5.12.2)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.0)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.36.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    zeitwerk (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  guard (~> 2.15)
+  guard-rspec (~> 4.7)
+  guard-rubocop (~> 1.3)
+  human_enum!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.72.0)
+  rubocop-performance (~> 1.5)
+  rubocop-rspec (~> 1.36)
+  sqlite3 (~> 1.4)
+
+BUNDLED WITH
+   2.0.2

data/Guardfile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+guard :rubocop, all_on_start: false, cli: '-a' do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+  end
+end

data/Rakefile

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

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "human_enum"
+require 'bundler/setup'
+require 'human_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.
@@ -10,5 +11,5 @@ require "human_enum"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/human_enum.gemspec

@@ -1,40 +1,46 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'human_enum/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "human_enum"
+  spec.name          = 'human_enum'
   spec.version       = HumanEnum::VERSION
-  spec.authors       = ["Rafael Soares"]
-  spec.email         = ["rafasoaresms@gmail.com"]
-
-  spec.summary       = %q{Adds simple and easy I18n support for Rails enums}
-  spec.description   = %q{This gem allows you to specify enum value translations
-    like any other ActiveRecord attrubute and adds helper methods to get
-    humanized translations of enum values}
-  spec.homepage      = "https://github.com/rafasoares/human_enum"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
+  spec.authors       = ['Rafael Soares']
+  spec.email         = ['rafasoaresms@gmail.com']
+
+  spec.summary       = 'Adds simple and easy I18n support for Rails enums'
+  spec.description   = 'This gem allows you to specify enum value translations
+    like any other ActiveRecord attribute and adds helper methods to get
+    humanized translations of enum values'
+  spec.homepage      = 'https://github.com/rafasoares/human_enum'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rafasoares/human_enum'
+  spec.metadata['changelog_uri'] = 'https://github.com/rafasoares/human_enum/blob/master/CHANGELOG.md'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_development_dependency 'rubocop', '~> 0.72.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.36'
+
+  spec.add_development_dependency 'guard', '~> 2.15'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.3'
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
 
-  spec.add_dependency "activerecord",  '> 5.0.0'
+  spec.add_dependency 'activerecord', '> 5.0.0'
 end

data/lib/human_enum.rb

@@ -1,21 +1,32 @@
-require "human_enum/version"
+# frozen_string_literal: true
+
+require 'human_enum/version'
 require 'active_support/concern'
 require 'active_support/core_ext/array'
+require 'active_model/naming'
 require 'active_model/translation'
+require 'active_record/type'
 require 'active_record/enum'
 
+# # About Human Enum
+# Human Enum allows you to easily translate `enum` values in [ActiveRecord]
+# models
+
+# [ActiveRecord]: https://api.rubyonrails.org/v5.2.3/classes/ActiveRecord/Enum.html
 module HumanEnum
+  class Error < StandardError; end
+
   extend ActiveSupport::Concern
 
   included do
-    def human_enum_value enum_name
+    def human_enum_value(enum_name)
       enum_value = send enum_name
       self.class.human_enum_value(enum_name, enum_value) unless enum_value.nil?
     end
   end
 
   class_methods do
-    def enum definitions
+    def enum(definitions)
       super definitions
 
       definitions.keys.without(:_prefix, :_suffix).each do |name|
@@ -23,7 +34,7 @@ module HumanEnum
       end
     end
 
-    def human_enum_value enum_name, enum_value
+    def human_enum_value(enum_name, enum_value)
       attributes_scope = "#{i18n_scope}.attributes"
       enum_key = "#{enum_name.to_s.pluralize}.#{enum_value}"
 
@@ -37,14 +48,14 @@ module HumanEnum
       I18n.translate defaults.shift, default: defaults
     end
 
-    def human_enum enum_name
+    def human_enum(enum_name)
       send :define_method, "human_#{enum_name}" do
         human_enum_value enum_name
       end
 
       collection_name = enum_name.to_s.pluralize
       self.class.send :define_method, "human_#{collection_name}" do
-        self.human_enum_value enum_name, nil
+        human_enum_value enum_name, nil
       end
     end
   end

data/lib/human_enum/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HumanEnum
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: human_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rafael Soares
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-04 00:00:00.000000000 Z
+date: 2019-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,104 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -68,7 +166,7 @@ dependencies:
         version: 5.0.0
 description: |-
   This gem allows you to specify enum value translations
-      like any other ActiveRecord attrubute and adds helper methods to get
+      like any other ActiveRecord attribute and adds helper methods to get
       humanized translations of enum values
 email:
 - rafasoaresms@gmail.com
@@ -76,11 +174,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/workflows/gempush.yml"
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".semaphore/semaphore.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -93,7 +201,9 @@ homepage: https://github.com/rafasoares/human_enum
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rafasoares/human_enum
+  source_code_uri: https://github.com/rafasoares/human_enum
+  changelog_uri: https://github.com/rafasoares/human_enum/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -109,8 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Adds simple and easy I18n support for Rails enums