human_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c976855d597f75927fa829c1a2199670105a2138
+  data.tar.gz: a2b543e73651f4163120846393b829507e0f34f8
+SHA512:
+  metadata.gz: 958e5976a6ba8759dd3886d6e66b0fae721fe1a53ebb8f6440098311981ae9036d2451fb28d05e8813e79ffe420e3e215b52b1d8944047aa50a8f076323521c5
+  data.tar.gz: 0a7a9209d5d7da99aa7b5a49a1261973169924836f6a1adb0b56f93ca7ae249a4d1a8e8abd13c479ddf8b5487020c7847ad201e9cbe957dfaeb8c94ae83399cd

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require rails_helper
+--format=doc

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+### v0.1.0
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in human_attributes.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,187 @@
+PATH
+  remote: .
+  specs:
+    human_attributes (0.1.0)
+      enumerize (~> 1.1, >= 1.1.1)
+      factory_girl_rails (~> 4.6.0)
+      rails (~> 4.2, >= 4.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      arel (~> 6.0)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    enumerize (1.1.1)
+      activesupport (>= 3.2)
+    erubis (2.7.0)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.6.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
+    ffi (1.9.14)
+    formatador (0.2.5)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    guard (2.14.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.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)
+    i18n (0.7.0)
+    json (1.8.3)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.0.10)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.1)
+    nenv (0.3.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-rails (0.3.4)
+      pry (>= 0.9.10)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.7.1)
+      actionmailer (= 4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activerecord (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.7.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.3.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    slop (3.6.0)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.12)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-rspec (~> 4.7)
+  human_attributes!
+  pry
+  pry-rails
+  rspec-rails (~> 3.4.0)
+  sqlite3
+
+BUNDLED WITH
+   1.13.3

data/Guardfile

@@ -0,0 +1,15 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  spec_dic = "spec/dummy/spec"
+  # RSpec files
+  watch("spec/spec_helper.rb") { spec_dic }
+  watch("spec/rails_helper.rb") { spec_dic }
+  watch(%r{^spec\/dummy\/spec\/support\/(.+)\.rb$}) { spec_dic }
+  watch(%r{^spec\/dummy\/spec\/.+_spec\.rb$})
+  # Engine files
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/dummy/spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.+)\.rb$}) { |m| "spec/dummy/spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb)$}) { |m| "spec/dummy/spec/#{m[1]}#{m[2]}_spec.rb" }
+  # Dummy app files
+  watch(%r{^spec\/dummy\/app/(.+)\.rb$}) { |m| "spec/dummy/spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec\/dummy\/app/(.*)(\.erb)$}) { |m| "spec/dummy/spec/#{m[1]}#{m[2]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2016 Platanus
+
+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,402 @@
+# 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)
+  - [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)
+- [Rake Task](#rake-task)
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "human_attributes"
+```
+
+```bash
+bundle install
+```
+
+## Usage
+
+Suppose you have the following model:
+
+```ruby
+# == Schema Information
+#
+# Table name: purchases
+#
+#  id          :integer          not null, primary key
+#  paid        :boolean
+#  commission  :decimal(, )
+#  quantity    :integer
+#  state       :string
+#  expired_at  :datetime
+#  amount      :decimal(, )
+#  description :text
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#
+
+class Purchase < ActiveRecord::Base
+  extend Enumerize
+
+  STATES = %i{pending canceled finished}
+
+  enumerize :state, in: STATES, default: :pending
+
+  def commission_amount
+    amount * commission / 100.0
+  end
+end
+```
+
+Executing the `humanize` method, inside the class definition, will allow you to apply **Formatters** to `Purchase`'s attributes and methods.
+
+### Formatters
+
+#### Numeric
+
+With...
+
+```ruby
+pruchase = Purchase.new
+purchase.quantity = 20
+purchase.commission = 5.3
+```
+
+And having...
+
+```ruby
+class Purchase < ActiveRecord::Base
+  humanize :quantity, percentage: true
+  humanize :commission, :commission_amount, currency: { unit: "R$", separator: ",", delimiter: "" }
+end
+```
+
+You can do...
+
+```ruby
+purchase.human_quantity #=> "20.000%"
+purchase.human_commission #=> "R$5,30"
+purchase.human_commission_amount #=> R$1 060 000,03
+```
+
+The available numeric types are:`currency`, `number`, `size`, `percentage`, `phone`, `delimiter` and `precision`.
+
+And the options to use with numeric types, are the same as in [NumberHelper](http://api.rubyonrails.org/v4.2/classes/ActionView/Helpers/NumberHelper.html)
+
+#### Date
+
+With...
+
+```ruby
+pruchase = 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"
+```
+
+And having...
+
+```ruby
+class Purchase < ActiveRecord::Base
+  humanize :expired_at, date: { format: :short }
+  humanize :created_at, date: true
+  humanize :updated_at, , date: { format: "%Y" }
+end
+```
+
+You can do...
+
+```ruby
+purchase.human_expired_at #=> "04 Jun 09:20"
+purchase.human_created_at #=> "Mon, 04 Jun 1984 09:20:00 +0000"
+purchase.human_updated_at #=> "1984"
+```
+
+The options you can use with the date type are the same as in [Rails guides](http://guides.rubyonrails.org/v4.2/i18n.html#adding-date-time-formats)
+
+#### Boolean
+
+With...
+
+```ruby
+pruchase = Purchase.new
+purchase.paid = true
+```
+
+And `/your_app/config/locales/en.yml`
+
+```yaml
+en:
+  boolean:
+    positive: "Yes"
+    negative: "No"
+```
+
+Having...
+
+```ruby
+class Purchase < ActiveRecord::Base
+  humanize :paid, boolean: true
+end
+```
+
+You can do...
+
+```ruby
+purchase.human_paid #=> "Yes"
+purchase.paid = false
+purchase.human_paid #=> "No"
+```
+
+#### Enumerize
+
+Installing [Enumerize](https://github.com/brainspec/enumerize) gem with...
+
+```ruby
+pruchase = Purchase.new
+purchase.state = :finished
+```
+
+And `/your_app/config/locales/en.yml`
+
+```yaml
+en:
+  enumerize:
+    purchase:
+      state:
+        pending: "P."
+        finished: "F."
+        canceled: "C."
+```
+
+Having...
+
+```ruby
+class Purchase < ActiveRecord::Base
+  humanize :state, enumerize: true
+end
+```
+
+You can do...
+
+```ruby
+purchase.state = :finished
+purchase.human_state #=> "F."
+```
+
+#### Custom Formatter
+
+With...
+
+```ruby
+pruchase = Purchase.create!
+```
+
+And having...
+
+```ruby
+class Purchase < ActiveRecord::Base
+  humanize :id, custom: { formatter: ->(purchase, value) { "Purchase: #{value}-#{purchase.id}" } }
+end
+```
+
+You can do...
+
+```ruby
+purchase.human_id #=> "Purchase: 1-1"
+```
+
+### Common Options
+
+The following options are available to use with all the formatters presented before.
+
+#### Default
+
+With...
+
+```ruby
+pruchase = Purchase.new
+purchase.amount = nil
+```
+
+Having...
+
+```ruby
+class Purchase < ActiveRecord::Base
+  humanize :amount, currency: { default: 0 }
+end
+```
+
+You can do...
+
+```ruby
+purchase.human_amount #=> "$0"
+```
+
+#### Suffix
+
+Useful when you want to define multiple formatters for the same attribute.
+
+With...
+
+```ruby
+pruchase = Purchase.new
+purchase.paid = true
+purchase.amount = 20
+```
+
+Having...
+
+```ruby
+class Purchase < ActiveRecord::Base
+  humanize :paid, boolean: { suffix: "with_custom_suffix" }
+  humanize :amount, currency: { suffix: true }
+end
+```
+
+You can do...
+
+```ruby
+purchase.paid_with_custom_suffix #=> "Yes"
+purchase.amount_to_currency #=> "$20" # default suffix
+```
+
+### Multiple Formatters
+
+With...
+
+```ruby
+pruchase = Purchase.new
+purchase.amount = 20
+```
+
+Having...
+
+```ruby
+class Purchase < ActiveRecord::Base
+  humanize :amount, currency: { suffix: true }, percentage: { suffix: true }
+end
+```
+
+You can do...
+
+```ruby
+purchase.amount_to_currency #=> ""
+purchase.amount_to_percentage #=> ""
+```
+
+> Remember to use `:suffix` option to avoid name collisions
+
+### Humanize Active Record Attributes
+
+You can generate human representations for all the atributes of your ActiveRecord model like this:
+
+```ruby
+class Purchase < ActiveRecord::Base
+  humanize_attributes
+end
+```
+
+The `humanize_attributes` method will infer from the attribute's data type which formatter to choose.
+With our `Purchase` model we will get:
+
+```ruby
+purchase.human_id
+purchase.human_paid
+purchase.human_quantity
+purchase.human_commission
+purchase.human_amount
+purchase.human_expired_at
+purchase.expired_at_to_short_date
+purchase.human_created_at
+purchase.created_at_to_short_date
+purchase.human_updated_at
+purchase.updated_at_to_short_date
+```
+
+> You can pass to `humanize_attributes` the option `only: [:attr1, :attr2]` to humanize specific attributes. The `except` option works in similar way.
+
+### Rake Task
+
+You can run, from your terminal, the following task to show defined human attributes for a particular ActiveRecord model.
+
+`$ rake human_attrs:show[your-model-name]`
+
+So, with...
+
+```ruby
+class Purchase < ActiveRecord::Base
+  extend Enumerize
+
+  STATES = %i{pending canceled finished}
+
+  enumerize :state, in: STATES, default: :pending
+
+  humanize_attributes
+  humanize :state, enumerize: true
+  humanize :commission, percentage: true
+  humanize :amount, currency: true
+end
+```
+
+And running `rake human_attrs:show[purchase]`, you will see the following output:
+
+```
+human_id => Purchase: #1
+human_paid => Yes
+human_commission => 1000.990%
+human_quantity => 1
+human_expired_at => Fri, 06 Apr 1984 09:00:00 +0000
+expired_at_to_short_date => 06 Apr 09:00
+human_amount => $2,000,000.95
+human_created_at => Sat, 10 Dec 2016 20:06:28 +0000
+created_at_to_short_date => 10 Dec 20:06
+human_updated_at => Sat, 10 Dec 2016 20:06:28 +0000
+updated_at_to_short_date => 10 Dec 20:06
+human_state => Pending
+```
+
+## Testing
+
+To run the specs you need to execute, **in the root path of the gem**, the following command:
+
+```bash
+bundle exec guard
+```
+
+You need to put **all your tests** in the `/human_attributes/spec/dummy/spec/` directory.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/human_attributes/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+Human Attributes is maintained by [platanus](http://platan.us).
+
+## License
+
+Human Attributes is © 2016 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require "bundler/setup"
+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__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+Bundler::GemHelper.install_tasks