mongoid_translate 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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,113 @@
+# Mongoid Translate
+
+## Installation
+
+Ruby 1.9.2 is required.
+
+Install it with rubygems:
+
+    gem install mongoid_translate
+
+With bundler, add it to your `Gemfile`:
+
+``` ruby
+gem "mongoid_translate", "~>0.1.0"
+```
+
+## Usage
+
+### Exemple :
+
+``` ruby
+class Article
+  include Mongoid::Document
+
+  # add Translate module
+  include Mongoid::Translate
+
+  # declare fields to be translate
+  translate :title, :content
+
+end
+```
+
+Create a Namespace model. You can add callbacks validation and so on.
+
+``` ruby
+class Translation::Article
+  include Mongoid::Document
+
+  # add Translation module
+  include Mongoid::Translation
+end
+```
+
+That'all folks.
+
+Display translation :
+
+``` ruby
+article = Article.first
+# return title according to I18n.locale, or main_translation.
+article.title
+
+# return list of existing translation for this resource
+article.languages
+
+# return main_translation
+article.main_translation
+
+# return english translation
+article.en
+```
+
+Persist translation. It's just an embeds_many relation.
+
+``` ruby
+article = Article.new
+article.translations << Translation::Article.new(:title => 'My title',
+                                                 :language => :en)
+```
+
+Slug
+----
+
+Slug are generated on translation creation. No change are made after.
+
+Slug feature can be added to translated model:
+
+``` ruby
+class Article
+  include Mongoid::Document
+
+  # add Translate module
+  include Mongoid::Translate
+
+  # add Slug module
+  include Mongoid::Translate::Slug
+
+  # declare fields to be translate
+  translate :title, :content
+
+  # Define field on which slug will be build.
+  slug_field :title
+
+end
+
+class Translation::Article
+  include Mongoid::Document
+
+  # add Translation module
+  include Mongoid::Translation
+
+  # add Slug module
+  include Mongoid::Translation::Slug
+
+end
+```
+
+## Copyright
+
+Copyright (c) 2012 af83
+
+Released under the MIT license

data/lib/mongoid/translate.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+module Mongoid
+  module Translate
+    extend ::ActiveSupport::Concern
+
+    # Include translations embeds relation.
+    # Add main_language field. [ Symbol ]
+    # Add delegate on translated_fields.
+    # Add index on translations.language.
+    #
+    included do
+      if self.to_s.include?('::')
+        class_name = self.to_s.split('::').insert(-2, "Translation").join('::')
+      else
+        class_name = "Translation::#{self}"
+      end
+      field :main_language, type: Symbol, default: lambda { I18n.locale }
+      embeds_many :translations, class_name: class_name
+      delegate :translated_fields, to: "self.class"
+      accepts_nested_attributes_for :translations
+      index 'translations.language'
+    end
+
+    module InstanceMethods
+      # Return list of existing languages
+      #
+      # @return [ Array ]
+      #
+      def languages
+        translations.map(&:language)
+      end
+
+      # Return main translation object
+      #
+      # @return [ Document ]
+      #
+      def main_translation
+        translations.where(language: main_language).one
+      end
+
+      def method_missing(method, *args, &block)
+        if self.languages.include?(method)
+          translations.where(language: method).one
+        else
+          super(method, *args, &block)
+        end
+      end
+
+    end # InstanceMethods
+
+    module ClassMethods
+      attr_accessor :translated_fields
+
+      # creates accessor methods
+      #
+      def translate(*argv)
+        self.translated_fields = *argv
+
+        translated_fields.each do |field|
+          # Return field for current locale.
+          #
+          # Otherwise, fallbacks to main_language.
+          #
+          # @return [ Object ]
+          #
+          define_method field do
+            locale = languages.include?(I18n.locale) ? I18n.locale : main_language
+            translations.where(language: locale).one.try(field)
+          end
+
+          # Setter on field for current locale.
+          #
+          # @return [ Object ]
+          #
+          define_method "#{field}=" do |arg|
+            translations.where(language: I18n.locale).one.try("#{field}=", arg)
+          end
+        end
+      end
+    end # ClassMethods
+  end # Translate
+end # Mongoid

data/lib/mongoid/translate/slug.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Mongoid
+  module Translate
+    module Slug
+      extend ::ActiveSupport::Concern
+
+      # Add scope on slug.
+      # Add index on slug.
+      #
+      included do
+        scope :by_slug, lambda {|slug| where('translations.slug' => slug )}
+        index 'translations.slug'
+      end
+
+      module InstanceMethods
+        # Return slug.
+        # Didn't want to mess with to_param.
+        #
+        # @example
+        #   document.to_slug
+        #
+        # @return [ String ]
+        #
+        def to_slug
+          locale = languages.include?(I18n.locale) ? I18n.locale : main_language
+          translations.where(language: locale).one.slug
+        end
+      end # InstanceMethods
+
+      module ClassMethods
+        attr_accessor :slugged
+
+        # Defines slug field.
+        #
+        def slug_field(slug_field)
+          self.slugged = slug_field
+        end
+
+      end # ClassMethods
+    end # Slug
+  end # Translate
+end # Mongoid

data/lib/mongoid/translate/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module Mongoid
+  module Translate
+    VERSION = "0.1.0"
+  end
+end

data/lib/mongoid/translation.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module Mongoid
+  module Translation
+    extend ::ActiveSupport::Concern
+
+    # Add translated fields to model.
+    # Add language field.
+    # Add uniqueness validation on language.
+    # Set relation on parent.
+    #
+    included do
+      class_name = self.to_s.gsub('Translation::', '')
+      name = self.to_s.sub(/^.*::/, '')
+      class_name.constantize.translated_fields.each do |field|
+        field field
+      end
+      field :language, type: Symbol, default: lambda { I18n.locale }
+      validates_uniqueness_of :language
+      embedded_in  name.underscore.to_sym, class_name: class_name
+    end
+
+    module InstanceMethods
+      # Check if current translation is main_translation.
+      #
+      # @return [ Boolean ]
+      #
+      def main_translation?
+        parent = self.class.to_s.sub(/^.*::/, '').underscore
+        self.send(parent).main_language == self.language
+      end
+    end # InstanceMethods
+  end # Translation
+end # Mongoid

data/lib/mongoid/translation/slug.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+module Mongoid
+  module Translation
+    module Slug
+      extend ::ActiveSupport::Concern
+
+      # Add slug field.
+      # Add callback for slug creation.
+      #
+      included do
+        field :slug, type: String
+        after_validation :set_slug
+      end
+
+      module InstanceMethods
+        # Slug creation.
+        #
+        # @return [ Object ]
+        #
+        def set_slug
+          if self.slug.blank? && slugged_field.present?
+            if translation_parent_class.send(:by_slug, slugged).one
+              self.slug = slugged_with_token
+            else
+              self.slug = slugged
+            end
+          end
+        end
+
+        private
+
+        def slugged_field
+          @slugged_field ||= self.send(translation_parent_class.slugged)
+        end
+
+        def slugged
+          @slugged ||= slugged_field.parameterize.blank? ? slugged_field : slugged_field.parameterize
+        end
+
+        def slugged_with_token
+          @slugged_with_token ||= [slugged, generate_token].join('-')
+        end
+
+        def translation_parent_class
+          self.class.to_s.sub('Translation::', '').constantize
+        end
+
+        def translation_parent
+          self.send(self.class.to_s.sub(/^.*::/, '').underscore)
+        end
+
+        def generate_token
+          SecureRandom.base64(4).tr('+/=', '-_ ').strip.delete("\n")
+        end
+      end
+    end # InstanceMethods
+  end # Translation
+end # Mongoid

data/lib/mongoid_translate.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+require 'mongoid'
+require 'mongoid/translate'
+require 'mongoid/translation'
+
+module Mongoid
+  module Translate
+    autoload :Slug,          'mongoid/translate/slug'
+  end # Translate
+
+  module Translation
+    autoload :Slug,          'mongoid/translation/slug'
+  end # Translation
+end # Mongoid

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_translate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- chatgris
+- klacointe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &76394790 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *76394790
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &76394330 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *76394330
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &76393870 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *76393870
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &76393200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *76393200
+description: Translate mongoid models.
+email: jboyer@af83.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/mongoid/translate.rb
+- lib/mongoid/translate/slug.rb
+- lib/mongoid/translate/version.rb
+- lib/mongoid/translation.rb
+- lib/mongoid/translation/slug.rb
+- lib/mongoid_translate.rb
+homepage: https://github.com/AF83/mongoid_translate
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Translate mongoid models.
+test_files: []
+has_rdoc: