acts_as_read_only_i18n_localised 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 858a5fd338c0dd5904ccda969f0bd6bb69c3d85f
-  data.tar.gz: 3bcfd46cd96babb4db0dec062cf360a9fef02f26
+  metadata.gz: ab853364bad7142e6f776a822a36766f25612b4a
+  data.tar.gz: c11eb5939d0a4e35887cde2e2e6f189cd5e5ca4f
 SHA512:
-  metadata.gz: 010c9fc1bf40a437c86fcfdfd9284f78a80b7fe4aea70568448626f9aef3740b2762c03c4cec40534ffc9e82999f163c66811d73d6e785452cc980bd1fa4c7c7
-  data.tar.gz: 6f062f43bf0aa91c747d330922b1f4023eeb07a14b8cef6458773f10e6def04a9030502853fd15ec217db53f1464c8a005c17ae3abdebc5b5c4aaff5ef2c5498
+  metadata.gz: 73cac04060acfa4c3785f1c9838db1f8c1b7dc891a0659a6ed219781205b1cadc371a12aedf8382016cb713caded0e729f293daf9e80b83df4f78097bedd9fae
+  data.tar.gz: 26294b91c0ce9e85b3a56442fdf38f0c95380df5ec594d261fdb697885c6880ab53cd7c9e0224580a617ca086ddeeeb74cae1f293a60872ba9ab6979314dce28

data/Gemfile

@@ -4,4 +4,5 @@ gemspec
 
 group :test do
   gem 'rake'
+  gem 'codeclimate-test-reporter'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acts_as_read_only_i18n_localised (0.0.2)
+    acts_as_read_only_i18n_localised (0.0.3)
       i18n
 
 GEM
@@ -10,10 +10,14 @@ GEM
     binding_of_caller (0.7.2)
       debug_inspector (>= 0.0.1)
     byebug (8.2.5)
+    codeclimate-test-reporter (0.5.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.1)
     debug_inspector (0.0.2)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     i18n (0.7.0)
+    json (1.8.3)
     method_source (0.8.2)
     pry (0.10.3)
       coderay (~> 1.1.0)
@@ -39,6 +43,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
 
 PLATFORMS
@@ -47,6 +56,7 @@ PLATFORMS
 DEPENDENCIES
   acts_as_read_only_i18n_localised!
   binding_of_caller
+  codeclimate-test-reporter
   pry
   pry-byebug
   pry-remote
@@ -54,4 +64,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.11.2
+   1.12.3

data/README.md

@@ -2,7 +2,7 @@
 
 A variant on the `acts_as_localized` theme for when you have static seed data in your system that must be localised.
 
-[![Build Status](https://travis-ci.org/davesag/acts_as_read_only_i18n_localised.svg?branch=master)](https://travis-ci.org/davesag/acts_as_read_only_i18n_localised) [![Code Climate](https://codeclimate.com/github/davesag/acts_as_read_only_i18n_localised/badges/gpa.svg)](https://codeclimate.com/github/davesag/acts_as_read_only_i18n_localised)
+[![Build Status](https://travis-ci.org/davesag/acts_as_read_only_i18n_localised.svg?branch=master)](https://travis-ci.org/davesag/acts_as_read_only_i18n_localised) [![Code Climate](https://codeclimate.com/github/davesag/acts_as_read_only_i18n_localised/badges/gpa.svg)](https://codeclimate.com/github/davesag/acts_as_read_only_i18n_localised) [![Test Coverage](https://codeclimate.com/github/davesag/acts_as_read_only_i18n_localised/badges/coverage.svg)](https://codeclimate.com/github/davesag/acts_as_read_only_i18n_localised/coverage)
 
 ## Why use it?
 
@@ -36,7 +36,7 @@ In `app/models/category.rb`
   
     class Category < ActiveRecord::Base
       include ActsAsReadOnlyI18nLocalised
-      validates :slug, format: {with: /^[a-z]+[\-?[a-z]*]*$/},
+      validates :slug, format: {with: /\A[a-z]+[-?[a-z]]\z/},
                        uniqueness: true,
                        presence: true
       has_many :products
@@ -48,7 +48,7 @@ In `app/models/category.rb`
 This simply generates appropriate `name` and `description` methods along the lines of
 
     def name
-      key = "#{self.class.name.pluralize}.#{slug}.name".downcase.to_sym
+      key = "#{self.table_name}.#{slug}.name".downcase.to_sym
       return I18n.t(key)
     end
 
@@ -56,27 +56,29 @@ with the effect that a call to `category.name` will always return the localised
 
 Depending on how your code is configured, `I18n` will raise a `MissingTranslationData` exception if the key does correspond to any data. Exceptions on missing keys is usually turned on in `development` and `test` but not on `staging` or `production`. See The [Rails I18n Guide](http://guides.rubyonrails.org/i18n.html) for more.
 
+*Note*: `acts_as_read_only_i18n_localised` will also work with non `active-record` classes. If there is no `self.table_name` method it will check to see if the `class.name` responds to `pluralize`, and use that if it can, otherwise it will just use the `class.name`.
+
 ### A more complex example
 
 Say your `categories` have their own sub `categories`.  Building on the previous example you might define the following
 
     class Category < ActiveRecord::Base
       include ActsAsReadOnlyI18nLocalised
-      validates :slug, format: {with: /^[a-z]+[\-?[a-z]*]*$/},
+      validates :slug, format: {with: /\A[a-z]+[-?[a-z]]\z/},
                        uniqueness: true,
                        presence: true
       has_many :products
       validates_associated :products
   
-      has_many :children, class_name: 'Category', foreign_key: :parent_id
-      belongs_to :parent, class_name: 'Category
+      has_many :categories, foreign_key: :parent_id
+      belongs_to :parent, class_name: 'Category'
 
       acts_as_read_only_i18n_localised :name, :description
       use_custom_slug :slug_maker
   
       def slug_maker
         reurn slug if parent.nil?
-        "#{@parent.slug}.children.#{slug}"
+        "#{@parent.slug}.categories.#{slug}"
       end
     end
 

data/lib/acts_as_read_only_i18n_localised.rb

@@ -22,26 +22,39 @@ module ActsAsReadOnlyI18nLocalised
   # Standard Ruby idiom for auto-adding class methods
   #
   module ClassMethods
-
-    def acts_as_read_only_i18n_localised(*attributes)
+    def _inject_standard_slug
       unless methods.include?(:custom_slug)
         define_method :custom_slug do
           send(:slug) if respond_to?(:slug)
         end
       end
+    end
+
+    def _inject_root_name
+      define_method :_root_name do
+        return table_name if respond_to?(:table_name)
+        root_name = self.class.name.gsub(/::/, '/')
+                        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                        .tr('-', '_')
+        return root_name.pluralize if root_name.respond_to?(:pluralize)
+        root_name
+      end
+    end
+
+    def acts_as_read_only_i18n_localised(*attributes)
+      _inject_standard_slug
+      _inject_root_name
 
       attributes.each do |attribute|
         define_method attribute do
-          I18n.t("#{self.class.name.gsub(/::/, '/')
-                                    .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-                                    .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-                                    .tr('-', '_')}.#{send(:custom_slug)}.#{attribute}"
-                 .downcase.to_sym)
+          return I18n.t("#{_root_name}.#{send(:custom_slug)}.#{attribute}"
+                        .downcase.to_sym)
         end
       end
     end
 
-    def use_custom_slug custom_slug_method
+    def use_custom_slug(custom_slug_method)
       define_method :custom_slug do
         send(custom_slug_method) if respond_to?(custom_slug_method)
       end

data/lib/acts_as_read_only_i18n_localised/version.rb

@@ -1,3 +1,3 @@
 module ActsAsReadOnlyI18nLocalised
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/spec/acts_as_read_only_i18n_localised_spec.rb

@@ -14,7 +14,7 @@ end
 
 class HierarchicalTestModel < TestModel
   attr_accessor :children, :parent
-  
+
   def initialize(options)
     super(options)
     unless options[:parent].nil?
@@ -28,17 +28,16 @@ end
 
 class CustomSlugModel
   include ActsAsReadOnlyI18nLocalised
-  
+
   acts_as_read_only_i18n_localised :name
   use_custom_slug :slug_maker
 
   def slug_maker
-    "slug_it_up"
+    'slug_it_up'
   end
 end
 
 describe 'ActsAsReadOnlyI18nLocalised' do
-  
   before :all do
     I18n.enforce_available_locales = false
     I18n.locale = :en
@@ -79,7 +78,7 @@ describe 'ActsAsReadOnlyI18nLocalised' do
     end
 
     context 'child' do
-      let(:child)    { HierarchicalTestModel.new(slug: 'child', parent: parent) }
+      let(:child) { HierarchicalTestModel.new(slug: 'child', parent: parent) }
       let(:key)      { :'hierarchical_test_model.parent.children.child.name' }
       let(:expected) { 'test-child-result' }
 
@@ -94,7 +93,7 @@ describe 'ActsAsReadOnlyI18nLocalised' do
   end
 
   context 'with custom slug maker' do
-    let!(:model)    { CustomSlugModel.new }
+    let!(:model)   { CustomSlugModel.new }
     let(:key)      { :"custom_slug_model.slug_it_up.name" }
     let(:expected) { 'test-custom-result' }
 
@@ -106,4 +105,33 @@ describe 'ActsAsReadOnlyI18nLocalised' do
       expect(model.name).to eq expected
     end
   end
+
+  context 'with access to String.pluralize', verify_stubs: false do
+    let(:model)    { TestModel.new(slug: 'test') }
+    let(:key)      { :"test_models.test.name" }
+    let(:expected) { 'test-custom-result' }
+
+    before :each do
+      allow_any_instance_of(String).to receive(:pluralize)
+        .and_return('test_models')
+    end
+
+    it 'the name has the expected value' do
+      expect(model.name).to eq expected
+    end
+  end
+
+  context 'with access to self.table_name', verify_stubs: false do
+    let(:model)    { TestModel.new(slug: 'test') }
+    let(:key)      { :"test_models.test.name" }
+    let(:expected) { 'test-custom-result' }
+
+    before :each do
+      allow(model).to receive(:table_name).and_return('test_models')
+    end
+
+    it 'the name has the expected value' do
+      expect(model.name).to eq expected
+    end
+  end
 end

data/spec/db_helper.rb

@@ -1,3 +1,13 @@
+require 'codeclimate-test-reporter'
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter.new(
+    [
+      SimpleCov::Formatter::HTMLFormatter,
+      CodeClimate::TestReporter::Formatter
+    ]
+  )
+end
+
 require 'rspec'
 require 'pry'
 require 'spec_helper'

data/spec/spec_helper.rb

@@ -26,7 +26,6 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
-  # allow us to disable verify_partial_doubles on a case by case basis.
   config.around(:each, verify_stubs: false) do |ex|
     config.mock_with :rspec do |mocks|
       mocks.verify_partial_doubles = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_read_only_i18n_localised
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dave Sag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simple mechanism to allow localised lookups of seed data.