human_attributes 0.6.0 → 0.7.0

data/README.md

@@ -1,23 +1,32 @@
-# Human Attributes [![Gem Version](https://badge.fury.io/rb/human_attributes.svg)](https://badge.fury.io/rb/human_attributes) [![Build Status](https://travis-ci.org/platanus/human_attributes.svg?branch=master)](https://travis-ci.org/platanus/human_attributes) [![Coverage Status](https://coveralls.io/repos/github/platanus/human_attributes/badge.svg)](https://coveralls.io/github/platanus/human_attributes)
+# Human Attributes
+[![Gem Version](https://badge.fury.io/rb/human_attributes.svg)](https://badge.fury.io/rb/human_attributes)
+[![CircleCI](https://circleci.com/gh/platanus/human_attributes.svg?style=shield)](https://app.circleci.com/pipelines/github/platanus/human_attributes)
+[![Coverage Status](https://coveralls.io/repos/github/platanus/human_attributes/badge.svg)](https://coveralls.io/github/platanus/human_attributes)
 
 It's a Gem to convert ActiveRecord models' attributes and methods to human readable representations of these.
 
-- [Installation](#installation)
-- [Usage](#usage)
-- [Formatters](#formatters)
-  - [Numeric](#numeric)
-  - [Date](#date)
-  - [DateTime](#datetime)
-  - [Boolean](#boolean)
-  - [Enumerize](#enumerize)
-  - [Custom Formatter](#custom-formatter)
-- [Common Options](#common-options)
-  - [Default](#default)
-  - [Suffix](#suffix)
-- [Multiple Formatters](#multiple-formatters)
-- [Humanize Active Record Attributes](#humanize-active-record-attributes)
-- [Integration with Draper Gem](#integration-with-draper-gem)
-- [Rake Task](#rake-task)
+- [Human Attributes](#human-attributes)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Formatters](#formatters)
+      - [Numeric](#numeric)
+      - [Date](#date)
+      - [DateTime](#datetime)
+      - [Boolean](#boolean)
+      - [Enumerize](#enumerize)
+      - [Custom Formatter](#custom-formatter)
+    - [Common Options](#common-options)
+      - [Default](#default)
+      - [Suffix](#suffix)
+    - [Multiple Formatters](#multiple-formatters)
+    - [Humanize Active Record Attributes](#humanize-active-record-attributes)
+    - [Integration with Draper Gem](#integration-with-draper-gem)
+    - [Rake Task](#rake-task)
+  - [Testing](#testing)
+  - [Publishing](#publishing)
+  - [Contributing](#contributing)
+  - [Credits](#credits)
+  - [License](#license)
 
 ## Installation
 
@@ -501,6 +510,17 @@ bundle exec guard
 
 You need to put **all your tests** in the `/human_attributes/spec/dummy/spec/` directory.
 
+## Publishing
+
+On master/main branch...
+
+1. Change `VERSION` in `lib/gemaker/version.rb`.
+2. Change `Unreleased` title to current version in `CHANGELOG.md`.
+3. Run `bundle install`.
+4. Commit new release. For example: `Releasing v0.1.0`.
+5. Create tag. For example: `git tag v0.1.0`.
+6. Push tag. For example: `git push origin v0.1.0`.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -4,7 +4,7 @@ rescue LoadError
   puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
 load "rails/tasks/statistics.rake"
 Bundler::GemHelper.install_tasks

data/human_attributes.gemspec

@@ -1,4 +1,4 @@
-$:.push File.expand_path("../lib", __FILE__)
+$:.push File.expand_path("lib", __dir__)
 
 # Maintain your gem"s version:
 require "human_attributes/version"
@@ -19,14 +19,18 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.test_files = Dir["spec/**/*"]
 
-  s.add_dependency "rails", ">= 4.2.0"
   s.add_dependency "factory_bot"
-  s.add_development_dependency "enumerize", "~> 1", ">= 1.1.1"
-  s.add_development_dependency "draper", "~> 2.1.0"
+  s.add_dependency "rails", ">= 4.2.0"
+
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "draper"
+  s.add_development_dependency "enumerize", "~> 2.1"
+  s.add_development_dependency "guard-rspec", "~> 4.7"
   s.add_development_dependency "pry"
   s.add_development_dependency "pry-rails"
+  s.add_development_dependency "rspec_junit_formatter"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "rubocop", "~> 1.9"
+  s.add_development_dependency "rubocop-rails"
   s.add_development_dependency "sqlite3"
-  s.add_development_dependency "rspec-rails", "~> 3.4"
-  s.add_development_dependency "guard-rspec", "~> 4.7"
-  s.add_development_dependency "coveralls"
 end

data/lib/human_attributes/extension.rb

@@ -17,14 +17,16 @@ module HumanAttributes
           next if col.name.ends_with?("_id")
           next if included_attrs && !included_attrs.include?(col.name.to_sym)
           next if excluded_attrs && excluded_attrs.include?(col.name.to_sym)
+
           humanize_from_type(col)
         end
       end
 
       def humanizers
         return [] unless @humanizers
+
         @humanizers.uniq!
-        @humanizers.reject! { |method| !method_defined?(method) }
+        @humanizers.select! { |method| method_defined?(method) }
         @humanizers
       end
 
@@ -60,10 +62,10 @@ module HumanAttributes
   end
 end
 
-ActiveRecord::Base.send(:include, HumanAttributes::Extension)
+ActiveRecord::Base.include(HumanAttributes::Extension)
 
 begin
-  Draper::Decorator.send(:include, HumanAttributes::Extension)
+  Draper::Decorator.include(HumanAttributes::Extension)
 rescue NameError
   nil
 end

data/lib/human_attributes/formatters/base.rb

@@ -16,6 +16,7 @@ module HumanAttributes
       def method_name
         return "human_#{attribute}" if suffix.blank?
         return "#{attribute}_#{suffix_by_type(type)}" if suffix == true
+
         "#{attribute}_#{suffix}"
       end
 

data/lib/human_attributes/formatters/enumerize.rb

@@ -3,6 +3,7 @@ module HumanAttributes
     class Enumerize < Base
       def apply(_instance, value)
         return unless value
+
         raise_error('NotEnumerizeAttribute') unless value.class.to_s == "Enumerize::Value"
         value.text
       end

data/lib/human_attributes/formatters_builder.rb

@@ -37,6 +37,7 @@ module HumanAttributes
 
     def get_options(options)
       return {} if options == true
+
       raise_error('InvalidAttributeOptions') unless options.is_a?(Hash)
       options
     end

data/lib/human_attributes/version.rb

@@ -1,3 +1,3 @@
 module HumanAttributes
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/dummy/Rakefile

@@ -1,6 +1,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require_relative "config/application"
 
 Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link human_attributes_manifest.js

data/spec/dummy/app/assets/stylesheets/application.css

@@ -6,9 +6,9 @@
  * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
  *
  * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
  *
  *= require_tree .
  *= require_self

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,5 +1,2 @@
 class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
-  protect_from_forgery with: :exception
 end

data/spec/dummy/app/{assets/javascripts → javascript/packs}/application.js

@@ -5,9 +5,11 @@
 // or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
 //
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
 //
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
+//= require rails-ujs
+//= require activestorage
 //= require_tree .

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/models/purchase.rb

@@ -16,7 +16,7 @@
 
 require "enumerize"
 
-class Purchase < ActiveRecord::Base
+class Purchase < ApplicationRecord
   extend Enumerize
 
   STATES = %i{pending canceled finished}

data/spec/dummy/app/views/layouts/application.html.erb

@@ -1,14 +1,15 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
-  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
+  <head>
+    <title>Dummy</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
 
-<%= yield %>
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+  </head>
 
-</body>
+  <body>
+    <%= yield %>
+  </body>
 </html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application', __FILE__)
-require_relative '../config/boot'
-require 'rails/commands'
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/dummy/bin/rake

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
+require_relative "../config/boot"
+require "rake"
 Rake.application.run

data/spec/dummy/bin/setup

@@ -1,29 +1,33 @@
 #!/usr/bin/env ruby
-require 'pathname'
+require "fileutils"
 
 # path to your application root.
-APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+APP_ROOT = File.expand_path('..', __dir__)
 
-Dir.chdir APP_ROOT do
-  # This script is a starting point to setup your application.
-  # Add necessary setup steps to this file:
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
 
-  puts "== Installing dependencies =="
-  system "gem install bundler --conservative"
-  system "bundle check || bundle install"
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
 
   # puts "\n== Copying sample files =="
-  # unless File.exist?("config/database.yml")
-  #   system "cp config/database.yml.sample config/database.yml"
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
   # end
 
   puts "\n== Preparing database =="
-  system "bin/rake db:setup"
+  system! 'bin/rails db:prepare'
 
   puts "\n== Removing old logs and tempfiles =="
-  system "rm -f log/*"
-  system "rm -rf tmp/cache"
+  system! 'bin/rails log:clear tmp:clear'
 
   puts "\n== Restarting application server =="
-  system "touch tmp/restart.txt"
+  system! 'bin/rails restart'
 end

data/spec/dummy/config.ru

@@ -1,4 +1,6 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment', __FILE__)
+require_relative "config/environment"
+
 run Rails.application
+Rails.application.load_server

data/spec/dummy/config/application.rb

@@ -1,32 +1,22 @@
-require File.expand_path('../boot', __FILE__)
+require_relative "boot"
 
-# Pick the frameworks you want:
-require "active_record/railtie"
-require "action_controller/railtie"
-require "action_mailer/railtie"
-require "action_view/railtie"
-require "sprockets/railtie"
-# require "rails/test_unit/railtie"
+require "rails/all"
 
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)
 require "human_attributes"
 
 module Dummy
   class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
+    config.load_defaults Rails::VERSION::STRING.to_f
 
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
   end
 end
-

data/spec/dummy/config/boot.rb

@@ -1,5 +1,5 @@
 # Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
 
-require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
-$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: test
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production