acts_as_read_only_i18n_localised 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d49d07db700e026f139a9734fd231b13d8305d86
-  data.tar.gz: 1a3fd6440e06b304458e741a1e6ccb3dca0bf0bd
+  metadata.gz: 858a5fd338c0dd5904ccda969f0bd6bb69c3d85f
+  data.tar.gz: 3bcfd46cd96babb4db0dec062cf360a9fef02f26
 SHA512:
-  metadata.gz: 4383f8c270f5ba8a6638968e69efa5b5d2911a78e6c70b174b403da30b51caae2a631cf2399a69b5b5d43e0ffea73a80ad1e8cb92cd600b21c4605ab6b64ba8f
-  data.tar.gz: 7d10db3e855a7f976ae40c4945f83b05ebfb2fdb553cfe93f955f6c5092ba24a343f3306e1953102150792661f14ddadfb8e1bbfa5002ef763ce91ec80d913b3
+  metadata.gz: 010c9fc1bf40a437c86fcfdfd9284f78a80b7fe4aea70568448626f9aef3740b2762c03c4cec40534ffc9e82999f163c66811d73d6e785452cc980bd1fa4c7c7
+  data.tar.gz: 6f062f43bf0aa91c747d330922b1f4023eeb07a14b8cef6458773f10e6def04a9030502853fd15ec217db53f1464c8a005c17ae3abdebc5b5c4aaff5ef2c5498

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acts_as_read_only_i18n_localised (0.0.1)
+    acts_as_read_only_i18n_localised (0.0.2)
       i18n
 
 GEM

data/README.md

@@ -12,6 +12,10 @@ A variant on the `acts_as_localized` theme for when you have static seed data in
 
 ## Example of use
 
+In your `Gemfile`
+
+    gem 'acts_as_read_only_i18n_localised'
+
 In `config/locales/categories.en.yml`
 
     en:
@@ -52,8 +56,34 @@ 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.
 
+### 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]*]*$/},
+                       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
+
+      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}"
+      end
+    end
+
 ## Seeding your database
 
+### simple case
+
 In `db/seeds.rb` add something like
 
     require 'i18n'
@@ -62,8 +92,38 @@ In `db/seeds.rb` add something like
       Category.create(slug: key)
     end
 
+### with a hierarchy
+
+In `db/seeds.rb` add something like
+
+    require 'i18n'
+
+    I18n.t(:categories).each do |key, data|
+      cat = Category.where(slug: key).first_or_create!
+      if data[:categories]
+        data[:categories].each do |inner_key, inner_data|
+          Category.where(slug: inner_key, parent: cat).first_or_create!
+        end
+      end
+    end
+
+Or preferably something recursive, though the above will do if you are only going 1 level deep.
+
 # Development
 
+This gem requires Ruby version 2.0.0 or better. It is tested against the following Rubies.
+
+* `2.0.0`
+* `2.1.6`
+* `2.2.4`
+* `2.3.0`
+
+Before you do anything do this:
+
+```sh
+bundle install
+```
+
 ## To build the gem
 
     gem build acts_as_read_only_i18n_localised.gemspec
@@ -76,3 +136,16 @@ or
 
     rake
 
+You can also run the following QA tools against the codebase if you have them installed.
+
+* `rubocop` (on its own without any of the `codeclimate` stuff.)
+* `codeclimate` (which will also run `rubocop` itself.)
+
+## Contributing
+
+Contributions and ideas are welcome.
+
+If you have ideas on how to improve the codebase or feature-set, please add them as issues so they can be discussed.
+
+For contributing code please see [CONTRIBUTING](CONTRIBUTING.md) for details on how to do that.
+

data/lib/acts_as_read_only_i18n_localised.rb

@@ -22,20 +22,29 @@ module ActsAsReadOnlyI18nLocalised
   # Standard Ruby idiom for auto-adding class methods
   #
   module ClassMethods
-    def underscore(string)
-      string
-    end
 
     def acts_as_read_only_i18n_localised(*attributes)
+      unless methods.include?(:custom_slug)
+        define_method :custom_slug do
+          send(:slug) if respond_to?(:slug)
+        end
+      end
+
       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(:slug)}.#{attribute}"
+                                    .tr('-', '_')}.#{send(:custom_slug)}.#{attribute}"
                  .downcase.to_sym)
         end
       end
     end
+
+    def use_custom_slug custom_slug_method
+      define_method :custom_slug do
+        send(custom_slug_method) if respond_to?(custom_slug_method)
+      end
+    end
   end
 end

data/lib/acts_as_read_only_i18n_localised/version.rb

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

data/spec/acts_as_read_only_i18n_localised_spec.rb

@@ -12,11 +12,33 @@ class TestModel
   acts_as_read_only_i18n_localised :name
 end
 
-describe 'ActsAsReadOnlyI18nLocalised' do
-  let(:model)    { TestModel.new(slug: 'test') }
-  let(:key)      { :'test_model.test.name' }
-  let(:expected) { 'test-result' }
+class HierarchicalTestModel < TestModel
+  attr_accessor :children, :parent
+  
+  def initialize(options)
+    super(options)
+    unless options[:parent].nil?
+      @parent = options[:parent]
+      @children ||= []
+      @children << self
+      @slug = "#{@parent.slug}.children.#{slug}"
+    end
+  end
+end
+
+class CustomSlugModel
+  include ActsAsReadOnlyI18nLocalised
+  
+  acts_as_read_only_i18n_localised :name
+  use_custom_slug :slug_maker
 
+  def slug_maker
+    "slug_it_up"
+  end
+end
+
+describe 'ActsAsReadOnlyI18nLocalised' do
+  
   before :all do
     I18n.enforce_available_locales = false
     I18n.locale = :en
@@ -26,8 +48,62 @@ describe 'ActsAsReadOnlyI18nLocalised' do
     allow(I18n).to receive(:t).with(key).and_return(expected)
   end
 
-  it 'has a name method' do
-    expect(model).to respond_to :name
-    expect(model.name).to eq expected
+  context 'with no hierarchy' do
+    let(:model)    { TestModel.new(slug: 'test') }
+    let(:key)      { :'test_model.test.name' }
+    let(:expected) { 'test-result' }
+
+    it 'responds to name' do
+      expect(model).to respond_to :name
+    end
+
+    it 'the name has the expected value' do
+      expect(model.name).to eq expected
+    end
+  end
+
+  context 'with simple hierarchy' do
+    let(:parent) { HierarchicalTestModel.new(slug: 'parent') }
+
+    context 'parent' do
+      let(:key)      { :'hierarchical_test_model.parent.name' }
+      let(:expected) { 'test-parent-result' }
+
+      it 'responds to name' do
+        expect(parent).to respond_to :name
+      end
+
+      it 'the name has the expected value' do
+        expect(parent.name).to eq expected
+      end
+    end
+
+    context 'child' do
+      let(:child)    { HierarchicalTestModel.new(slug: 'child', parent: parent) }
+      let(:key)      { :'hierarchical_test_model.parent.children.child.name' }
+      let(:expected) { 'test-child-result' }
+
+      it 'responds to name' do
+        expect(child).to respond_to :name
+      end
+
+      it 'the name has the expected value' do
+        expect(child.name).to eq expected
+      end
+    end
+  end
+
+  context 'with custom slug maker' do
+    let!(:model)    { CustomSlugModel.new }
+    let(:key)      { :"custom_slug_model.slug_it_up.name" }
+    let(:expected) { 'test-custom-result' }
+
+    it 'responds to name' do
+      expect(model).to respond_to :name
+    end
+
+    it 'the name has the expected value' do
+      expect(model.name).to eq expected
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_read_only_i18n_localised
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dave Sag