awesome_hstore_translate 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe3efb120f94ec493d1060c558f02ab06cc623af
-  data.tar.gz: cf33e049416e9b841095eca3826f599f25618989
+  metadata.gz: 776affdef8d15b23476763a402444c5cd9d77f52
+  data.tar.gz: 119148870bf3a17cda07f86c017652c742345aae
 SHA512:
-  metadata.gz: af5faab9487a7aa3c4597a601b94d5056a04c6bca14e488d90e8cf6c12fa80bdaa3262f61ed75f34d659402376b35f073e2822d609f568f2ed8303157a84e1a4
-  data.tar.gz: e39ba04a78f235157946d7794c53e4326977cca208154195d5924ab8be59e289212a15d8a93a03f85c7ee2886345c2fe44788ee240b8dbc3ac2ec90ae25ced9d
+  metadata.gz: f1c7928bd63ef520c96de9183905e2008a7140fd43644cb7499b1eec466c464555104dfba7b041a9e2fb4fdf77a59e31638dcbcb400ee68a730d092b8898c8e6
+  data.tar.gz: 6123dae82312fa213b1b4cc7160d02276846c281d48755537a3acdc579d83cdc8b923f3af462464ced517995a79b8b3ebf23b2873c452b29e34fac5bf90235ae

data/README.md

@@ -1,6 +1,8 @@
 # Awesome Hstore Translate
+[![Gem Version](https://badge.fury.io/rb/awesome_hstore_translate.svg)](https://badge.fury.io/rb/awesome_hstore_translate)
+
 This gem uses PostgreSQLs hstore datatype and ActiveRecord models to translate model data. It is based on the gem
-[hstore_translate](https://github.com/Leadformance/hstore_translate) by Rob Worely.
+[`hstore_translate`](https://github.com/Leadformance/hstore_translate) by Rob Worely.
 
  - It's ready for Rails 5
  - No extra columns or tables needed to operate
@@ -8,14 +10,18 @@ This gem uses PostgreSQLs hstore datatype and ActiveRecord models to translate m
  - Everything is well tested
 
 ## Features
- - [x] Attributes override / Raw attributes
- - [x] Fallbacks
- - [x] Language specific accessors
- - [ ] Support instance selection (e. g. `where`, `find_by`)
- - [ ] Support `friendly_id`
+ - [x] `v0.1.0` Attributes override / Raw attributes
+ - [x] `v0.1.0` Fallbacks
+ - [x] `v0.1.0` Language specific accessors
+ - [x] `v0.2.0` Awesome Hstore Translate as drop in replace for [`hstore_translate`](https://github.com/Leadformance/hstore_translate)
+   - `with_[attr]_translation(str)` is not supported
+ - [x] `v0.2.0` Support record selection via ActiveRecord (e. g. `where`, `find_by`)
+   - maybe it's a bad idea to implement this
+ - [ ] `backlog` Support `friendly_id` (see `friendly_id-awesome_hstore` gem)
 
 ## Requirements
  - ActiveRecord `>= 5`
+   - Please use [`hstore_translate`](https://github.com/Leadformance/hstore_translate), if you are on an older version.
  - I18n
 
 ## Installation
@@ -129,6 +135,21 @@ p.title_en # => English title
 p.title_de # => Deutscher Titel
 ```
 
+### Find
+`awesome_hstore_translate` patches ActiveRecord, so you can conviniently use `where` and `find_by` as you like.
+```ruby
+Page.create!(:title_en => 'English title', :title_de => 'Deutscher Titel')
+Page.create!(:title_en => 'Another English title', :title_de => 'Noch ein Deutscher Titel')
+
+Page.where(title: 'Another English title')  # => Page
+```
+
+
+### Upgrade from [`hstore_translate`](https://github.com/Leadformance/hstore_translate)
+1. Replace the [`hstore_translate`](https://github.com/Leadformance/hstore_translate) with `awesome_hstore_translate` in your Gemfile
+1. Activate accessors, if you used the [`hstore_translate`](https://github.com/Leadformance/hstore_translate) accessors
+1. Replace `with_[attr]_translation(str)` with equivalents (see "Support record selection via ActiveRecord" feature)
+
 ## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/lib/awesome_hstore_translate/active_record.rb

@@ -4,6 +4,8 @@ module AwesomeHstoreTranslate
     autoload :ActAsTranslatable, 'awesome_hstore_translate/active_record/act_as_translatable'
     autoload :Attributes, 'awesome_hstore_translate/active_record/attributes'
     autoload :ClassMethods, 'awesome_hstore_translate/active_record/class_methods'
+    autoload :Core, 'awesome_hstore_translate/active_record/core'
     autoload :InstanceMethods, 'awesome_hstore_translate/active_record/instance_methods'
+    autoload :QueryMethods, 'awesome_hstore_translate/active_record/query_methods'
   end
 end

data/lib/awesome_hstore_translate/active_record/act_as_translatable.rb

@@ -47,6 +47,7 @@ module AwesomeHstoreTranslate
         expose_translated_attrs(attr_names)
 
         include InstanceMethods
+        extend Core::ClassMethods
         extend ClassMethods
       end
     end

data/lib/awesome_hstore_translate/active_record/class_methods.rb

@@ -24,6 +24,13 @@ module AwesomeHstoreTranslate
       def toggle_fallback
         translation_options[:fallbacks] = !translation_options[:fallbacks]
       end
+
+      private
+
+      # Override the default relation methods in order to inject custom finder methods for hstore translations.
+      def relation
+        super.extending!(QueryMethods)
+      end
     end
   end
 end

data/lib/awesome_hstore_translate/active_record/core.rb

@@ -0,0 +1,22 @@
+module AwesomeHstoreTranslate
+  module ActiveRecord
+    module Core
+      module ClassMethods
+        def find_by(*args)
+          attrs = args.first
+          if attrs.is_a?(Hash) && contains_translated_attributes(attrs)
+            where(attrs).limit(1).first
+          else
+            super(args)
+          end
+        end
+
+        private
+
+        def contains_translated_attributes(attrs)
+          !(self.translated_attribute_names & attrs.keys).empty?
+        end
+      end
+    end
+  end
+end

data/lib/awesome_hstore_translate/active_record/instance_methods.rb

@@ -8,11 +8,13 @@ module AwesomeHstoreTranslate
         locales << locale
         locales += get_fallback_for_locale(locale) || [] if translation_options[:fallbacks]
 
-        translations = read_attribute(attr)
+        translations = read_raw_attribute(attr)
 
-        locales.uniq.each do |cur|
-          if translations.has_key?(cur.to_s) && !translations[cur.to_s].empty?
-            return translations[cur.to_s]
+        if translations
+          locales.uniq.each do |cur|
+            if translations.has_key?(cur.to_s) && !translations[cur.to_s].empty?
+              return translations[cur.to_s]
+            end
           end
         end
 
@@ -20,7 +22,7 @@ module AwesomeHstoreTranslate
       end
 
       def read_raw_attribute(attr)
-        read_attribute(attr)
+        read_attribute(get_column_name(attr))
       end
 
       def write_translated_attribute(attr, value, locale= I18n.locale)
@@ -30,12 +32,22 @@ module AwesomeHstoreTranslate
       end
 
       def write_raw_attribute(attr, value)
-        write_attribute(attr, value)
+        write_attribute(get_column_name(attr), value)
       end
 
       def get_fallback_for_locale(locale)
         I18n.fallbacks[locale] if I18n.respond_to?(:fallbacks)
       end
+
+      private
+
+      def get_column_name(attr)
+        column_name = attr.to_s
+        # detect column from original hstore_translate
+        column_name << '_translations' if !has_attribute?(column_name) && has_attribute?("#{column_name}_translations")
+
+        column_name
+      end
     end
   end
 end

data/lib/awesome_hstore_translate/active_record/query_methods.rb

@@ -0,0 +1,37 @@
+module AwesomeHstoreTranslate
+  module ActiveRecord
+    module QueryMethods
+      class WhereChain < ::ActiveRecord::QueryMethods::WhereChain
+      end
+
+      def where(opts = :chain, *rest)
+        if opts == :chain
+          WhereChain.new(spawn)
+        elsif opts.blank?
+          return self
+        elsif opts.is_a?(Hash)
+          translated_attrs = translated_attributes(opts)
+          normal_attrs = opts.reject{ |key, _| translated_attrs.include? key}
+          query = spawn
+          query.where!(normal_attrs) unless normal_attrs.empty?
+
+          translated_attrs.each do |attribute|
+            if opts[attribute].is_a?(String)
+              query.where!("'#{opts[attribute]}' = any(avals(#{attribute}))")
+            else
+              super(opts, rest)
+            end
+          end
+          return query
+        end
+        super(opts, rest)
+      end
+
+      private
+
+      def translated_attributes(opts)
+        self.translated_attribute_names & opts.keys
+      end
+    end
+  end
+end

data/lib/awesome_hstore_translate/version.rb

@@ -1,3 +1,3 @@
 module AwesomeHstoreTranslate
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: awesome_hstore_translate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robin Bühler
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -161,7 +161,9 @@ files:
 - lib/awesome_hstore_translate/active_record/act_as_translatable.rb
 - lib/awesome_hstore_translate/active_record/attributes.rb
 - lib/awesome_hstore_translate/active_record/class_methods.rb
+- lib/awesome_hstore_translate/active_record/core.rb
 - lib/awesome_hstore_translate/active_record/instance_methods.rb
+- lib/awesome_hstore_translate/active_record/query_methods.rb
 - lib/awesome_hstore_translate/version.rb
 homepage: https://github.com/openscript/awesome_hstore_translate
 licenses: