human_attributes 0.6.0 → 0.7.1

data/README.md

@@ -1,23 +1,33 @@
-# 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)
+      - [Enum](#enum)
+      - [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
 
@@ -74,7 +84,7 @@ Executing the `humanize` method, inside the class definition, will allow you to
 With...
 
 ```ruby
-pruchase = Purchase.new
+purchase = Purchase.new
 purchase.quantity = 20
 purchase.commission = 5.3
 ```
@@ -105,7 +115,7 @@ And the options to use with numeric types, are the same as in [NumberHelper](htt
 With...
 
 ```ruby
-pruchase = Purchase.new
+purchase = Purchase.new
 purchase.expired_at = "04/06/1984 09:20:00"
 purchase.created_at = "04/06/1984 09:20:00"
 purchase.updated_at = "04/06/1984 09:20:00"
@@ -144,7 +154,7 @@ purchase.human_updated_at #=> "1984"
 With...
 
 ```ruby
-pruchase = Purchase.new
+purchase = Purchase.new
 purchase.expired_at = "04/06/1984 09:20:00"
 purchase.created_at = "04/06/1984 09:20:00"
 purchase.updated_at = "04/06/1984 09:20:00"
@@ -183,7 +193,7 @@ purchase.human_updated_at #=> "1984"
 With...
 
 ```ruby
-pruchase = Purchase.new
+purchase = Purchase.new
 purchase.paid = true
 ```
 
@@ -217,7 +227,7 @@ purchase.human_paid #=> "No"
 Installing [Enumerize](https://github.com/brainspec/enumerize) gem with...
 
 ```ruby
-pruchase = Purchase.new
+purchase = Purchase.new
 purchase.state = :finished
 ```
 
@@ -248,12 +258,92 @@ purchase.state = :finished
 purchase.human_state #=> "F."
 ```
 
+#### Enum
+
+Having...
+
+```ruby
+class Purchase < ActiveRecord::Base
+  enum payment_method: [:credit, :debit, :cash, :bitcoin]
+end
+```
+
+You can add
+```ruby
+class Purchase < ActiveRecord::Base
+  enum payment_method: [:credit, :debit, :cash, :bitcoin]
+  humanize :payment_method, enum: true
+end
+```
+
+And `/your_app/config/locales/en.yml`
+
+```yaml
+en:
+  activerecord:
+   attributes:
+    purchase:
+      payment_methods:
+        credit: "Credit Card"
+        debit: "Debit Card"
+        cash: "Cash"
+        bitcoin: "Bitcoin"
+```
+
+
+And then you can do...
+
+```ruby
+purchase = Purchase.new
+purchase.payment_method = :debit
+purchase.human_payment_method #=> "Debit Card"
+```
+
+If you want to use the same enum translations for multiple models, use this locales structure:
+
+`/your_app/config/locales/en.yml`
+
+```yaml
+en:
+  enum:
+    default:
+      payment_methods:
+        credit: "Credit Card"
+        debit: "Debit Card"
+        cash: "Cash"
+        bitcoin: "Bitcoin"
+```
+
+and then in other models will also work:
+
+```ruby
+class Debt < ActiveRecord::Base
+  enum payment_method: [:credit, :debit, :cash, :bitcoin]
+  humanize :payment_method, enum: true
+end
+```
+
+```ruby
+purchase = Purchase.new
+purchase.payment_method = :debit
+
+debt = Debt.new
+debt.payment_method = :bitcoin
+
+purchase.human_payment_method #=> "Debit Card"
+debt.human_payment_method #=> "Bitcoin"
+```
+
+
+
+
+
 #### Custom Formatter
 
 With...
 
 ```ruby
-pruchase = Purchase.create!
+purchase = Purchase.create!
 ```
 
 And having...
@@ -279,7 +369,7 @@ The following options are available to use with all the formatters presented bef
 With...
 
 ```ruby
-pruchase = Purchase.new
+purchase = Purchase.new
 purchase.amount = nil
 ```
 
@@ -304,7 +394,7 @@ Useful when you want to define multiple formatters for the same attribute.
 With...
 
 ```ruby
-pruchase = Purchase.new
+purchase = Purchase.new
 purchase.paid = true
 purchase.amount = 20
 ```
@@ -330,7 +420,7 @@ purchase.amount_to_currency #=> "$20" # default suffix
 With...
 
 ```ruby
-pruchase = Purchase.new
+purchase = Purchase.new
 purchase.amount = 20
 ```
 
@@ -501,6 +591,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/config.rb

@@ -1,74 +1,56 @@
 module HumanAttributes
   module Config
-    TYPES = [
-      {
-        name: :currency,
-        category: :numeric,
-        formatter: :number_to_currency,
-        suffix: :to_currency
-      },
-      {
-        name: :number,
-        category: :numeric,
-        formatter: :number_to_human,
-        suffix: :to_human
-      },
-      {
-        name: :size,
-        category: :numeric,
-        formatter: :number_to_human_size,
-        suffix: :to_human_size
-      },
-      {
-        name: :percentage,
-        category: :numeric,
-        formatter: :number_to_percentage,
-        suffix: :to_percentage
-      },
-      {
-        name: :phone,
-        category: :numeric,
-        formatter: :number_to_phone,
-        suffix: :to_phone
-      },
-      {
-        name: :delimiter,
-        category: :numeric,
-        formatter: :number_with_delimiter,
-        suffix: :with_delimiter
-      },
-      {
-        name: :precision,
-        category: :numeric,
-        formatter: :number_with_precision,
-        suffix: :with_precision
-      },
-      {
-        name: :date,
-        category: :date,
-        suffix: :to_human_date
-      },
-      {
-        name: :datetime,
-        category: :datetime,
-        suffix: :to_human_datetime
-      },
-      {
-        name: :boolean,
-        category: :boolean,
-        suffix: :to_human_boolean
-      },
-      {
-        name: :enumerize,
-        category: :enumerize,
-        suffix: :to_human_enum
-      },
-      {
-        name: :custom,
-        category: :custom,
-        suffix: :to_custom_value
+    def self.build_type(name, category, suffix, formatter = nil)
+      config_type = {
+        name: name,
+        category: category,
+        suffix: suffix
       }
-    ]
+      if formatter
+        config_type[:formatter] = formatter
+      end
+      config_type
+    end
+
+    TYPES = [
+      [:currency, :numeric, :to_currency, :number_to_currency],
+      [:number, :numeric, :to_human, :number_to_human],
+      [:size, :numeric, :to_human_size, :number_to_human_size],
+      [:percentage, :numeric, :to_percentage, :number_to_percentage],
+      [:phone, :numeric, :to_phone, :number_to_phone],
+      [:delimiter, :numeric, :with_delimiter, :number_with_delimiter],
+      [:precision, :numeric, :with_precision, :number_with_precision],
+      [:date, :date, :to_human_date],
+      [:datetime, :datetime, :to_human_datetime],
+      [:boolean, :boolean, :to_human_boolean],
+      [:enumerize, :enumerize, :to_human_enum],
+      [:enum, :enum, :to_human_enum],
+      [:custom, :custom, :to_custom_value]
+    ].map { |config_type| build_type(*config_type) }
+
+    OPTIONS = {
+      boolean: [
+        { boolean: true }
+      ],
+      date: [
+        { date: true },
+        { date: { format: :short, suffix: "to_short_date" } },
+        { date: { format: :short, suffix: "to_long_date" } },
+        { datetime: true },
+        { datetime: { format: :short, suffix: "to_short_datetime" } },
+        { datetime: { format: :short, suffix: "to_long_datetime" } }
+      ],
+      datetime: [
+        { datetime: true },
+        { datetime: { format: :short, suffix: "to_short_datetime" } },
+        { datetime: { format: :short, suffix: "to_long_datetime" } }
+      ],
+      decimal: [{ delimiter: true }],
+      enum: [{ enum: true }],
+      float: [{ delimiter: true }],
+      id: [{ custom: { formatter: ->(_o, value) { "#{_o.model_name.human}: ##{value}" } } }],
+      integer: [{ delimiter: true }]
+    }
 
     def category_by_type(type)
       type_config(type)[:category]

data/lib/human_attributes/engine.rb

@@ -17,6 +17,7 @@ module HumanAttributes
       require_relative "./formatters/datetime"
       require_relative "./formatters/boolean"
       require_relative "./formatters/enumerize"
+      require_relative "./formatters/enum"
       require_relative "./formatters/custom"
       require_relative "./method_builder"
       require_relative "./extension"

data/lib/human_attributes/errors.rb

@@ -18,6 +18,12 @@ module HumanAttributes
       end
     end
 
+    class NotEnumAttribute < RuntimeError
+      def initialize
+        super("needs to be a Rails Enum")
+      end
+    end
+
     class MissingFormatterOption < RuntimeError
       def initialize
         super("custom type needs formatter option with a proc")

data/lib/human_attributes/extension.rb

@@ -7,7 +7,9 @@ module HumanAttributes
         formatters = HumanAttributes::FormattersBuilder.new(attrs, options).build
         @builder ||= HumanAttributes::MethodBuilder.new(self)
         @humanizers ||= []
-        formatters.each { |formatter| @humanizers << @builder.build(formatter) }
+        formatters.each do |formatter|
+          @humanizers << @builder.build(formatter)
+        end
       end
 
       def humanize_attributes(options = {})
@@ -16,54 +18,47 @@ module HumanAttributes
         columns.each do |col|
           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)
+          next if 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
 
       private
 
       def humanize_from_type(col)
-        if col.name == "id"
-          humanize(:id, custom: { formatter: ->(_o, value) { "#{model_name.human}: ##{value}" } })
-        elsif col.type == :date
-          humanize_date(col.name)
-        elsif col.type == :datetime
-          humanize_date(col.name)
-          humanize_datetime(col.name)
-        elsif [:decimal, :float, :integer].include?(col.type)
-          humanize(col.name, delimiter: true)
-        elsif col.type == :boolean
-          humanize(col.name, boolean: true)
+        if HumanAttributes::Config::OPTIONS.has_key? humanizer_type(col)
+          HumanAttributes::Config::OPTIONS[humanizer_type(col)].each do |options|
+            humanize(col.name, options)
+          end
         end
       end
 
-      def humanize_date(attr_name)
-        humanize(attr_name, date: true)
-        humanize(attr_name, date: { format: :short, suffix: "to_short_date" })
-        humanize(attr_name, date: { format: :short, suffix: "to_long_date" })
-      end
-
-      def humanize_datetime(attr_name)
-        humanize(attr_name, datetime: true)
-        humanize(attr_name, datetime: { format: :short, suffix: "to_short_datetime" })
-        humanize(attr_name, datetime: { format: :short, suffix: "to_long_datetime" })
+      def humanizer_type(col)
+        type = col.type
+        if col.name == 'id'
+          type = 'id'
+        elsif defined_enums.has_key?(col.name)
+          type = 'enum'
+        end
+        type.to_sym
       end
     end
   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/enum.rb

@@ -0,0 +1,25 @@
+module HumanAttributes
+  module Formatters
+    class Enum < Base
+      def apply(_instance, value)
+        return unless value
+
+        is_enum_defined = _instance.class.defined_enums.has_key?(attribute.to_s)
+        raise_error('NotEnumAttribute') unless is_enum_defined
+        class_name = _instance.class.name.underscore
+        pluralized_attribute = attribute.to_s.pluralize
+        attr_key = "activerecord.attributes.#{class_name}.#{pluralized_attribute}.#{value}"
+        enum_key = "enum.defaults.#{pluralized_attribute}.#{value}"
+        translate(attr_key, translate(enum_key, value))
+      end
+
+      def translate(key, default)
+        I18n.t(key,  { default: default })
+      end
+
+      def enum_defined?(_instance)
+        _instance.class.defined_enums.has_key?(attribute.to_s)
+      end
+    end
+  end
+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.1"
 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