human_value 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjA2YThmZGU4NmIyZTY5NDFiNzFmNDkzOTRkYjY5NTM3OTU5NmRlNg==
+  data.tar.gz: !binary |-
+    ODc4OGViZDJhOTRjYmNjNjdiN2JlYjZkZGIxZDI2MTdjNDA1NTlhMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OTI4YzM5MWQyNTdmZjEwNjAzMGUzZmQ0NWUwMWQ4ZGMxYTUyYmFjMDZhZDE3
+    MjJhMjAzYmFkZGJkNjI3NTM2Y2I0MDVmMTA4YjUxNWE0NGMwZmVhMjZkN2Rh
+    MzM2MTRlM2NiNDUxZWUyZDI5ZmM2MmZlYTE1ZTg1MmI4ZDExMzU=
+  data.tar.gz: !binary |-
+    YzA1OGUwZDc5ZjYyYWUwODEzNWVhNDJiMDBmMWE3OTZmOGQyNTI1MzNmNTBm
+    ZjFjZDI1ZWYwNTc1MWU2YWQwNTFlNDY5YmQ2NDMyODc0N2ViM2ZhOTg2YTcz
+    ZmVkOWE5NjhhZmYzNGQ3OGU3MzliYmM0Zjg0ZTQ1ZWVmYmEzY2I=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in human_value.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ben Eddy
+
+MIT License
+
+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,101 @@
+# Human Value
+
+`HumanValue` translates values into human-friendly formats.
+
+For example, humans like to read "1,000,000" rather than "1000000", or "12/12/2012 at 4:30 PM MT" rather than "2012-12-12 16:30:00 -0700".
+
+### Example usage in Rails
+
+In Rails, use the `h` abbreviated helper method.
+
+```ERB
+<span><%= h 1000 %></span>
+```
+
+to produce
+
+```HTML
+<span>1,000</span>
+```
+
+## Installation
+
+Add this line to your application's Gemfile and run `bundle install`:
+
+    gem 'human_value'
+
+## Default humanizations
+
+Out of the box, `HumanValue` knows how to humanize the following types:
+
+- Booleans
+- Numerics
+- Dates and times
+- Enumerables
+- Classes with a `model_name` (i.e. `ActiveModel` and `ActiveRecord` classes)
+
+## Extensions
+
+`HumanValue` also comes with extensions for humanizing values from common Rails libraries. Extensions are enabled as follows in a `config/initializers/human_value.rb` file.
+
+```Ruby
+HumanValue.enable_extension(:carrierwave)
+```
+
+#### The following extensions are supported:
+
+- `:carrierwave`
+  - renders image attachments as `<img>` tags
+  - renders file attachments as `<a>` tags
+
+- `:naming`
+  - tries to render names by calling a `name` method
+
+## Writing custom humanizations
+
+You may add your own humanizations using the `HumanValue.humanization` hook. You must define a `test` block (i.e. does this humanization apply) and a `coerce` block which performs the humanization.
+
+For example, let's assume we have a `User` class with a `name` method which should fall back to the `email` method. We can add a custom humanization in `config/initializers/human_value.rb`.
+
+```Ruby
+HumanValue.humanization :user do
+  test   { |value| value.is_a?(User) }
+  coerce { |value| value.name || value.email }
+end
+```
+
+```ERB
+<% user_1 = User.new(name: "Timothy Tyler", email: "tim@gmail.com") %>
+<% user_2 = User.new(name: nil, email: "anon@gmail.com") %>
+
+<%= h user_1 %>
+<%= h user_2 %>
+```
+
+which produces
+
+```HTML
+Timothy Tyler
+anon@gmail.com
+```
+
+## Overriding existing humanizations
+
+If you need to add a custom humanization which supercedes one of the default humanizations, use the `:prepend` option.
+
+For example, perhaps you want to humanize booleans to "Yep" and "Nope" rather than "Yes" and "No".
+
+```Ruby
+HumanValue.humanization :boolean, prepend: true do
+  test   { |value| [true, false].include?(value) }
+  coerce { |value| value ? "Yep" : "Nope" }
+end
+```
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/human_value.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'human_value/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "human_value"
+  spec.version       = HumanValue::VERSION
+  spec.authors       = ["Ben Eddy"]
+  spec.email         = ["bae@foraker.com"]
+  spec.description   = %q{Ruby values fit for human consumption}
+  spec.summary       = %q{HumanValue humanizes Ruby values to strings and supports adding custom humanizations}
+  spec.homepage      = "https://github.com/foraker/human_value"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "i18n"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/human_value.rb

@@ -0,0 +1,55 @@
+require "active_support/core_ext"
+require "active_support/number_helper"
+require "human_value/humanization"
+require "human_value/value"
+require "human_value/helpers"
+
+Gem.find_files("human_value/extensions/**/*.rb").each { |path| require path }
+Gem.find_files("human_value/integration/**/*.rb").each { |path| require path }
+
+module HumanValue
+  def self.humanizations
+    @humanizations ||= []
+  end
+
+  def self.humanize(type, options = {}, &block)
+    modifier = options[:prepend] ? :unshift : :push
+    humanizations.public_send modifier, Humanization.new(type).instance_eval(&block)
+  end
+
+  def self.enable_extension(extension_name)
+    "HumanValue::Extensions::#{extension_name.to_s.classify}".constantize.load
+  rescue NameError
+    raise "Unknown extension '#{extension_name}'"
+  end
+
+  humanize :boolean do
+    test   { |v| [true, false].include?(v) }
+    coerce { |v| v ? "Yes" : "No" }
+  end
+
+  humanize :number do
+    test   { |v| v.is_a?(Numeric) }
+    coerce { |v| ActiveSupport::NumberHelper.number_to_delimited(v) }
+  end
+
+  humanize :timeish do
+    test   { |v| v.respond_to?(:strftime) }
+    coerce { |v| I18n.localize(v) }
+  end
+
+  humanize :humanizable do
+    test   { |v| v.respond_to?(:human) }
+    coerce { |v| v.human }
+  end
+
+  humanize :enumerable do
+    test   { |v| v.respond_to?(:each) }
+    coerce { |v| Value.wrap(v).join(', ') }
+  end
+
+  humanize :model_name do
+    test   { |v| v.respond_to?(:model_name) }
+    coerce { |v| v.model_name.human }
+  end
+end

data/lib/human_value/extensions/carrierwave.rb

@@ -0,0 +1,21 @@
+module HumanValue
+  module Extensions
+    module Carrierwave
+      def self.load
+        HumanValue.humanize :image do
+          test do |v|
+            v.respond_to?(:content_type) &&
+            v.content_type.to_s.starts_with?("image")
+          end
+
+          coerce { |v| "<img src='#{v}'>".html_safe }
+        end
+
+        HumanValue.humanize :file do
+          test   { |v| v.respond_to?(:content_type) }
+          coerce { |v| "<a href='#{v}'>#{v.filename}</a>".html_safe }
+        end
+      end
+    end
+  end
+end

data/lib/human_value/extensions/naming.rb

@@ -0,0 +1,13 @@
+module HumanValue
+  module Extensions
+    module Naming
+      def self.load
+        HumanValue.humanize :named do
+          test   { |v| v.respond_to?(:name) }
+          coerce { |v| v.name.to_s }
+        end
+      end
+    end
+  end
+end
+

data/lib/human_value/helpers.rb

@@ -0,0 +1,9 @@
+module HumanValue
+  module Helpers
+    def humanize(value)
+      HumanValue::Value.new(value).to_s
+    end
+
+    alias :h :humanize
+  end
+end

data/lib/human_value/humanization.rb

@@ -0,0 +1,25 @@
+module HumanValue
+  class Humanization
+    def initialize(type)
+      @type
+    end
+
+    def matches?(value)
+      @test.call(value)
+    end
+
+    def call(value)
+      @coerce.call(value)
+    end
+
+    def test(&block)
+      @test = block
+      self
+    end
+
+    def coerce(&block)
+      @coerce = block
+      self
+    end
+  end
+end

data/lib/human_value/integration/rails.rb

@@ -0,0 +1,9 @@
+if defined?(::Rails)
+  module HumanValue
+    class Railtie < ::Rails::Railtie
+      initializer "human_value.view_helpers" do
+        ActionView::Base.send :include, HumanValue::Helpers
+      end
+    end
+  end
+end

data/lib/human_value/integration/sinatra.rb

@@ -0,0 +1,3 @@
+if defined?(Sinatra)
+  ::Sinatra::Application.send(:helpers, HumanValue::Helpers)
+end

data/lib/human_value/value.rb

@@ -0,0 +1,23 @@
+module HumanValue
+  class Value
+    def self.wrap(objects)
+      objects.map{ |object| new(object) }
+    end
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def to_s
+      HumanValue.humanizations.each do |humanization|
+        return humanization.call(raw) if humanization.matches?(raw)
+      end
+
+      raw.to_s
+    end
+
+    private
+
+    attr_reader :raw
+  end
+end

data/lib/human_value/version.rb

@@ -0,0 +1,3 @@
+module HumanValue
+  VERSION = "0.0.1"
+end

data/spec/extensions/carrierwave_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+module HumanValue
+  describe Value do
+    before do
+      HumanValue.enable_extension(:carrierwave)
+    end
+
+    describe "an image attachment" do
+      it "returns an image tag" do
+        attachment = double({
+          content_type: "image/jpeg",
+          to_s:         "/path/to/file.jpg"
+        })
+        expect(coerced(attachment)).to eq "<img src='/path/to/file.jpg'>"
+      end
+    end
+
+    describe "a file attachment" do
+      it "returns an link to the file" do
+        attachment = double({
+          content_type: "application/pdf",
+          filename:     "file.pdf",
+          to_s:         "/path/to/file.pdf"
+        })
+
+        expect(coerced(attachment)).to eq "<a href='/path/to/file.pdf'>file.pdf</a>"
+      end
+    end
+  end
+end
+

data/spec/extensions/naming_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+module HumanValue
+  describe Value do
+    before do
+      HumanValue.enable_extension(:naming)
+    end
+
+    describe "a named thing" do
+      it "returns the name" do
+        named = double(name: "Billows Wendley")
+        expect(coerced(named)).to eq "Billows Wendley"
+      end
+
+      it "handles missing names" do
+        named = double(name: nil)
+        expect(coerced(named)).to eq ""
+      end
+    end
+  end
+end
+
+

data/spec/human_value_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+module HumanValue
+  describe Value do
+    describe "#to_s" do
+      describe "a string" do
+        it "returns the string" do
+          expect(coerced("ABC")).to eq "ABC"
+        end
+      end
+
+      describe "nil" do
+        it "returns an empty string" do
+          expect(coerced(nil)).to eq ""
+        end
+      end
+
+      describe "a boolean" do
+        it "returns 'Yes' for true" do
+          expect(coerced(true)).to eq "Yes"
+        end
+
+        it "returns 'No' for false" do
+          expect(coerced(false)).to eq "No"
+        end
+      end
+
+      describe "a number" do
+        it "returns a number string" do
+          expect(coerced(400)).to eq "400"
+        end
+
+        it "adds delimiters" do
+          expect(coerced(4000)).to eq "4,000"
+        end
+      end
+
+      describe "a humanizable value" do
+        it "returns 'Yes' for true" do
+          humanizable = double(human: "Humanized")
+          expect(coerced(humanizable)).to eq "Humanized"
+        end
+      end
+
+      describe "a value with a model name" do
+        it "returns the human model name" do
+          humanizable = double(model_name: double(human: "Humanized"))
+          expect(coerced(humanizable)).to eq "Humanized"
+        end
+      end
+
+      describe "a time sort of thing" do
+        it "localizes Times" do
+          expect(coerced(Time.new(2012, 12, 12))).to eq "12/12/2012"
+        end
+
+        it "localizes Dates" do
+          expect(coerced(Date.new(2012, 12, 12))).to eq "12/12/2012"
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require "human_value"
+
+RSpec.configure do |config|
+  class MockI18n
+    def initialize(translations = {})
+      @translations = translations
+    end
+
+    def localize(value)
+      value.strftime('%m/%d/%Y')
+    end
+
+    def translate(value, options = {})
+      @translations.fetch(value) do
+        options[:default]
+      end
+    end
+  end
+
+  config.before do
+    stub_const("I18n", MockI18n.new)
+  end
+
+  def coerced(value)
+    HumanValue::Value.new(value).to_s
+  end
+end
+

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: human_value
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Eddy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-06 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby values fit for human consumption
+email:
+- bae@foraker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- human_value.gemspec
+- lib/human_value.rb
+- lib/human_value/extensions/carrierwave.rb
+- lib/human_value/extensions/naming.rb
+- lib/human_value/helpers.rb
+- lib/human_value/humanization.rb
+- lib/human_value/integration/rails.rb
+- lib/human_value/integration/sinatra.rb
+- lib/human_value/value.rb
+- lib/human_value/version.rb
+- spec/extensions/carrierwave_spec.rb
+- spec/extensions/nameable.rb
+- spec/extensions/naming_spec.rb
+- spec/human_value_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/foraker/human_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.0.3
+signing_key: 
+specification_version: 4
+summary: HumanValue humanizes Ruby values to strings and supports adding custom humanizations
+test_files:
+- spec/extensions/carrierwave_spec.rb
+- spec/extensions/nameable.rb
+- spec/extensions/naming_spec.rb
+- spec/human_value_spec.rb
+- spec/spec_helper.rb
+has_rdoc: