human_attribute_value 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8086c5af79f3b998473cd1721c12640c486fb59f
+  data.tar.gz: f6ea7f866376e75609bdd2c49e6b257bcb35df13
+SHA512:
+  metadata.gz: 9fcadcb54c3162c6ed6753ab6a16e930c7e0490f270651f8d472b29eb576e279be73af98a734c38dc1e7161bd1c3c4e09127381ff22c1fe453984eb8b8eda301
+  data.tar.gz: fc1a5e3b7bcd51590b316a3811dc2e11cdc751f021a57853b7596e6f49626c95fc14231b057d4db18ae86ce49f6f922fd9462fe6de1078605b90b7e5c75bb312

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,23 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zstandard.gemspec
+gemspec
+
+group :development, :test do
+  gem "benchmark-ips"
+  gem "bundler"
+  gem "rake"
+  gem "rubocop", "~> 0.41", require: false
+  gem "rspec",   "~> 3.0"
+  gem "simplecov"
+
+  if !ENV["CI"] && RUBY_ENGINE == "ruby"
+    gem "pry"
+
+    if RUBY_VERSION < "2.0.0"
+      gem "pry-nav"
+    else
+      gem "pry-byebug"
+    end
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michael Sievers
+
+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,88 @@
+# HumanAttributeValue
+
+Rails provides `.human_attribute_name`, for you to translate model names. But it lacks the same functionality when it comes to attribute values. This gems adds the missing piece, while being as close as possible to the present conventions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "human_attribute_value"
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Rails defines some conventions for model (attributes) translations, for example `activerecord.models` and `activerecord.attributes`. This gem adds `activerecord.values`.
+
+`config/locales/de.yml`
+
+```yml
+---
+de:
+  activerecord:
+    models:
+      company: Firma
+    attributes:
+      company:
+        name: Name
+        city: Stadt
+        size: Größe
+    # 
+    # This gem adds activerecord.values
+    #
+    values:
+      company:
+        city:
+          size:
+            small: klein
+            medium: mittel
+            large: groß
+          tags:
+            company: Firma
+            important: wichtig
+            green: ökologisch
+```
+
+In order to use `human_attribute_value` it needs to be included into your model or your `ApplicationRecord`.
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include HumanAttributeValue
+end
+```
+
+Now you can do the following.
+
+```ruby
+company = Company.create(name: "ACME Inc.", city: "Berlin", size: "large")
+
+# assuming your current locale is :de
+company.human_attribute_value(:size) # => "groß"
+```
+
+It respects serialized arrays as well. Let's assume you have an serialized `tags` array.
+
+```ruby
+company = Company.create(name: "ACME Inc.", tags: ["company". "important", "green"])
+
+# assuming your current locale is :de
+company.human_attribute_value(:tags) # => ["Firma", "wichtig", "ökologisch"]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nerdgeschoss/human_attribute_value.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+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 "human_attribute_value"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/human_attribute_value.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "human_attribute_value/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "human_attribute_value"
+  spec.version       = HumanAttributeValue::VERSION
+  spec.authors       = ["Michael Sievers"]
+  spec.email         = ["msievers@users.noreply.github.com"]
+
+  spec.summary       = %q{Translate rails models attribute values just like attribute names.}
+  spec.homepage      = "https://github.com/nerdgeschoss/human_attribute_value"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel"
+  spec.add_dependency "activesupport"
+end

data/lib/human_attribute_value.rb

@@ -0,0 +1,51 @@
+require "active_support/concern"
+require "human_attribute_value/version"
+
+module HumanAttributeValue
+  extend ActiveSupport::Concern
+
+  included do
+    extend ActiveModel::Translation unless self.is_a?(ActiveModel::Translation)
+  end
+
+  class_methods do
+    # adapted from activemodel-5.0.0/lib/active_model/translation.rb
+    def human_attribute_value(attribute, value, options = {})
+      options   = { count: 1 }.merge!(options)
+      parts     = attribute.to_s.split(".")
+      attribute = parts.pop
+      namespace = parts.join("/") unless parts.empty?
+      values_scope = "#{self.i18n_scope}.values"
+
+      if namespace
+        defaults = lookup_ancestors.map do |klass|
+          :"#{values_scope}.#{klass.model_name.i18n_key}/#{namespace}.#{attribute}.#{value}"
+        end
+        defaults << :"#{values_scope}.#{namespace}.#{attribute}.#{value}"
+      else
+        defaults = lookup_ancestors.map do |klass|
+          :"#{values_scope}.#{klass.model_name.i18n_key}.#{attribute}.#{value}"
+        end
+      end
+
+      defaults << :"values.#{attribute}.#{value}"
+      defaults << options.delete(:default) if options[:default]
+      defaults << value.try(:humanize) || value
+
+      options[:default] = defaults
+      I18n.translate(defaults.shift, options)
+    end
+  end
+
+  def human_attribute_value(attribute, options = {})
+    value = public_send(attribute)
+
+    if value.present?
+      if value.is_a?(Array)
+        value.map { |el| self.class.human_attribute_value(attribute, el, options) }
+      else
+        self.class.human_attribute_value(attribute, value, options)
+      end
+    end
+  end
+end

data/lib/human_attribute_value/version.rb

@@ -0,0 +1,3 @@
+module HumanAttributeValue
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: human_attribute_value
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Sievers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: 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'
+description: 
+email:
+- msievers@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- human_attribute_value.gemspec
+- lib/human_attribute_value.rb
+- lib/human_attribute_value/version.rb
+homepage: https://github.com/nerdgeschoss/human_attribute_value
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Translate rails models attribute values just like attribute names.
+test_files: []