olson 0.0.2 → 0.0.3

data/Gemfile

@@ -2,4 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in olson.gemspec
 gemspec
+
+gem 'rake'
+gem 'pry'
+
 gem 'rspec'
+gem 'guard', git: 'https://github.com/guard/guard.git'
+gem 'guard-rspec'
+gem 'guard-shell'
+gem 'rb-fsevent'

data/Gemfile.lock

@@ -0,0 +1,115 @@
+GIT
+  remote: https://github.com/guard/guard.git
+  revision: 1e853b2f8c9b092e79addc0a652e4d1a34eda224
+  specs:
+    guard (1.7.0)
+      formatador (>= 0.2.4)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+
+PATH
+  remote: .
+  specs:
+    olson (0.0.3)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    coderay (1.0.9)
+    colorize (0.5.8)
+    coveralls (0.6.3)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.1)
+    draper (1.1.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      request_store (~> 1.0.3)
+    erubis (2.7.0)
+    formatador (0.2.4)
+    guard-rspec (2.5.1)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    guard-shell (0.5.1)
+      guard (>= 1.1.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    listen (0.7.3)
+    lumberjack (1.0.3)
+    method_source (0.8.1)
+    mime-types (1.21)
+    multi_json (1.7.2)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.4)
+    rb-fsevent (0.9.3)
+    request_store (1.0.5)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.18.0)
+    tilt (1.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  coveralls
+  draper
+  guard!
+  guard-rspec
+  guard-shell
+  olson!
+  pry
+  rake
+  rb-fsevent
+  rspec

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', cli: '--format doc --color', keep_failed: false, all_after_pass: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/olson_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/fixtures/.*\.rb$})  { "spec" }
+end
+

data/README.md

@@ -2,6 +2,8 @@
 
 *Apparently it's a reference to Mad Men and Draper...*
 
+[![Gem Version](https://badge.fury.io/rb/olson.png)](http://badge.fury.io/rb/olson)
+[![Coverage Status](https://coveralls.io/repos/carnesmedia/olson/badge.png?branch=master)](https://coveralls.io/r/carnesmedia/olson)
 [![Code Climate](https://codeclimate.com/github/carnesmedia/olson.png)](https://codeclimate.com/github/carnesmedia/olson)
 
 Olson is a tool to help display identifiers to users. It’s basically a way to turn your decorator in to a wrapper for `.humanize` with automatic built-in support for I18n.

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/olson.rb

@@ -1,4 +1,4 @@
+require 'active_support/concern'
 require 'olson/instance_methods'
 require 'olson/class_methods'
 require 'olson/version'
-require 'active_support/concern'

data/lib/olson/class_methods.rb

@@ -30,13 +30,16 @@ module ClassMethods
       attr_options = :"#{ attr }_options"
       define_singleton_method attr_options do   # def status_options
         options_for_select_with_i18n attr,      #   options_for_select_with_i18n 'status',
-          model_class.send(attr_options)        #     User.status_options
+          source_class.send(attr_options)       #     User.status_options
       end                                       # end
     end
   end
 
   # Humanize an attribute using I18n, falling back to the humanized attributes value.
   #
+  # The `.default_humanize` method can be overridden to configure how values are humanized
+  # when they are not found in I18n.
+  #
   # I tend to store attributes like `status` or `role` as underscored strings (a string that
   # would be suitable for a method/variable name) sometimes a simple .humanize will do the
   # trick when it comes to displaying that value in the UI user but other times you need to
@@ -73,11 +76,28 @@ module ClassMethods
   #   @user.decorator.plan_status # => 'Current'
   #
   #   @user.activation_status = 'inactive'
-  #   @user.decorator.activation_status = 'Inactive'
-  def humanize(attribute, key, default = key.to_s.humanize)
-    i18n_with_scoped_defaults key, [model_name.i18n_key, attribute], default if key.present?
+  #   @user.decorator.activation_status # => 'Inactive'
+  def humanize(attribute, value, default = default_humanize(value))
+    i18n_with_scoped_defaults value, [model_name.i18n_key, attribute], default if value.present?
   end
 
+  # The default way to humanize a value when not found in I18n.
+  #
+  # To configure the default humanization, you can override `.default_humanize` in your
+  # decorator. For example, to use `String#titleize` instead of `String#humanize`:
+  #
+  #   # user_decorator.rb
+  #   class UserDecorator < ApplicationDecorator
+  #     decorates :user
+  #
+  #     def self.default_humanize(value)
+  #       value.to_s.titleize
+  #     end
+  #   end
+  #
+  def default_humanize(value)
+    value.to_s.humanize
+  end
 
   # Try to translate a key with I18n and a scope but fallback to less-and-less scope.
   # An example will explain more clearly:

data/lib/olson/instance_methods.rb

@@ -2,7 +2,7 @@ module Olson
   extend ActiveSupport::Concern
 
   # See +ApplicationDecorator.humanize+
-  def humanize(attribute, key = model.send(attribute), default = key.to_s.humanize)
-    self.class.humanize attribute, key, default
+  def humanize(attribute, value = model.send(attribute), default = self.class.default_humanize(value))
+    self.class.humanize attribute, value, default
   end
 end

data/lib/olson/version.rb

@@ -1,3 +1,3 @@
 module Olson
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/draper_initializer.rb

@@ -0,0 +1,3 @@
+class Draper::Decorator
+  include Olson
+end

data/spec/fixtures/human.rb

@@ -0,0 +1,19 @@
+# Human and HumanDecorator is an example without ActiveModel or Draper
+
+
+class Human
+  attr_accessor :status
+  def self.model_name
+    OpenStruct.new(i18n_key: "human")
+  end
+end
+
+class HumanDecorator < SimpleDelegator
+  include Olson
+  humanizes :status
+
+  alias_method :model, :__getobj__
+  def self.model_name
+    Human.model_name
+  end
+end

data/spec/fixtures/user.rb

@@ -0,0 +1,24 @@
+# User and UserDecorator is an example with ActiveModel and Draper
+
+class User
+  extend ActiveModel::Naming
+  attr_accessor :status
+
+  def self.status_options
+    %w[ approved rejected ]
+  end
+end
+
+class UserDecorator < Draper::Decorator
+  decorates :user
+  humanizes :status
+end
+
+class CustomUserDecorator < Draper::Decorator
+  decorates :user
+  humanizes :status
+
+  def self.default_humanize(value)
+    value.to_s.upcase
+  end
+end

data/spec/olson_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Olson do
+  context "when using Draper and ActiveModel" do
+    let(:object) { User.new }
+    let(:decorated) { UserDecorator.decorate(object) }
+
+    before { object.status = 'submitted' }
+
+    it "humanizes a field" do
+      decorated.status.should == "Submitted"
+    end
+
+    it 'humanizes with I18n when specified' do
+      object.status = 'rejected'
+      decorated.status.should == 'OMG Fail'
+    end
+
+    it 'humanizes options for select' do
+      UserDecorator.status_options.should == [
+        ["Approved", "approved"],
+        ["OMG Fail", "rejected"],
+      ]
+    end
+
+    context 'overriding the default behaviour' do
+      let(:decorated) { CustomUserDecorator.decorate(object) }
+
+      it "humanizes a field" do
+        decorated.status.should == "SUBMITTED"
+      end
+
+      it 'humanizes options for select' do
+        CustomUserDecorator.status_options.should == [
+          ["APPROVED", "approved"],
+          ["OMG Fail", "rejected"],
+        ]
+      end
+    end
+
+  end
+
+  context 'without draper' do
+    let(:object) { Human.new }
+    let(:decorated) { HumanDecorator.new(object) }
+
+    it 'humanizes a field' do
+      object.status = 'submitted'
+      decorated.status.should == 'Submitted'
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+
+require 'simplecov'
+require 'coveralls'
+
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter,
+]
+
+SimpleCov.start
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'olson'
+require 'ostruct'
+require 'active_model'
+require 'draper'
+require 'draper_initializer'
+
+spec_dir = Pathname.new(__FILE__).dirname
+
+Dir[spec_dir.join("fixtures/**/*.rb")].each { |f| require f }
+Dir[spec_dir.join("support/**/*.rb")].each { |f| require f }
+
+I18n.config.load_path << spec_dir.join('fixtures/en.yml')
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: olson
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,6 +28,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +76,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: draper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Object-oriented humanize
 email:
 - kristian@kristianfreeman.com
@@ -57,9 +105,16 @@ files:
 - lib/olson/version.rb
 - lib/olson.rb
 - Gemfile
+- Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - Rakefile
 - README.md
+- spec/draper_initializer.rb
+- spec/fixtures/human.rb
+- spec/fixtures/user.rb
+- spec/olson_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/carnesmedia/olson
 licenses: []
 post_install_message: 
@@ -72,20 +127,30 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2017626489828929657
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2017626489828929657
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Olson is a tool to help display identifiers to users. It’s basically a way
   to turn your decorator in to a wrapper for `.humanize` with automatic built-in support
   for I18n.  See [Using I18n and Draper to Render Database Attributes](http://blog.amielmartin.com/post/12341219947/using-i18n-and-draper-to-render-database-attributes)
   to read more about this concept.
-test_files: []
-has_rdoc: 
+test_files:
+- spec/draper_initializer.rb
+- spec/fixtures/human.rb
+- spec/fixtures/user.rb
+- spec/olson_spec.rb
+- spec/spec_helper.rb