magic_locales 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 498e601a13a04035afb16656a7cf9af152e67472
+  data.tar.gz: 360ebf86c851db764f25fe4e509befb3d684b4ae
+SHA512:
+  metadata.gz: fb9a01f7921ebbe5ca7d0c4ae95a2687b2a9872ba7f9aa7fbce22e420b453c76d590183b56e0fe2a3586d49ad14d3d51e6147fc5d6a24c76bf55be9df04c0177
+  data.tar.gz: f1a2b08cad2fea9d4d3dfbd010c2e244b336fb801499aeeaf4ef7af6a4fe91527d8d3da8c6e0ba4d6a2e87e30157c3f9e52cf85251f88a0859f3cf1facce9fce

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Torsten Wetzel
+
+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,42 @@
+# MagicLocales
+
+Rails gem to help with translations and locale changing. 
+Uses simple locale style like **`:en`** or **`:de`** .. more complex (**`en-US`**) style may follow. 
+
+The gem includes a seed file with most common european locales. 
+
+
+## Usage
+- add gem to your gemfile 
+```ruby
+  gem "magic_locales"
+```
+
+- run install generator
+```ruby
+  rails g magic_locales:install
+```
+
+- check new migration and migrate your database
+```ruby
+  bundle exec rake db:migrate
+```
+
+
+### Controller-Helper
+- in your application controller: 
+```ruby
+
+  include MagicLocaleHelper
+
+  before_action :get_user_language
+
+```
+
+`include MagicLocaleHelper` loads in the helper and `before_action :get_user_language` checks user language *(via db-field or accept-language)* .. now you can access your users `@accept_language`.
+
+
+
+
+#### License
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MagicLocales'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/app/controllers/magic_locales/base_controller.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+class MagicLocales::BaseController < ApplicationController
+  
+  # => layout proc { |controller| controller.request.xhr? ? false : "application" }
+  
+  before_action :authenticate_visitor
+  
+  
+  private
+
+    # overwrite for authentication
+    def authenticate_visitor
+      true
+    end
+
+end

data/lib/app/controllers/magic_locales/locales_controller.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+class MagicLocales::LocalesController < MagicLocales::BaseController
+  
+  # => layout proc { |controller| controller.request.xhr? ? 'xhr' : get_layout }
+  layout proc { |controller| controller.request.xhr? ? false : "application" }
+  
+  def index
+    # => @locales = ::MagicLocales::Locale.includes(:translations).with_translations(I18n.locale).order( 'mgclang_locale_translations.name ASC' )
+    @locales = MagicLocales::Locale.where(locale_state: "live").includes(:translations).with_translations(I18n.locale).order( 'mgclang_locale_translations.name ASC' )
+    @locales += MagicLocales::Locale.where(locale_state: "active").includes(:translations).with_translations(I18n.locale).order( 'mgclang_locale_translations.name ASC' )
+    @locales += MagicLocales::Locale.where(locale_state: "inactive").includes(:translations).with_translations(I18n.locale).order( 'mgclang_locale_translations.name ASC' )
+  end
+  
+  def new
+    @locale = MagicLocales::Locale.new()
+    render :form
+  end
+  
+  def create
+    @locale = MagicLocales::Locale.new(locale_params)
+    if @locale.save
+      redirect_to action: :index, notice: "Saved locale"
+    else
+      redirect_to action: :index, alert: "Error! #{@locale.errors.full_messages.join(" ")}"
+    end
+  end
+  
+  def edit
+    @locale = MagicLocales::Locale.find(params[:id])
+    render :form
+  end
+  
+  def update
+    @locale = MagicLocales::Locale.find(params[:id])
+    if @locale.update(locale_params)
+      redirect_to action: :index, notice: "Saved locale"
+    else
+      redirect_to action: :index, alert: "Error! #{@locale.errors.full_messages.join(" ")}"
+    end
+  end
+  
+  def trigger
+    @locale = MagicLocales::Locale.find( params[:id] )
+    @locale.do_transition!( params[:state].to_sym )
+    redirect_to action: :index
+  end
+  
+  def change_locale
+    if I18n.available_locales.include?( params[:locale].to_sym )
+      session[:user_locale] = params[:locale]
+      session[:locale] = params[:locale]
+      I18n.locale = params[:locale]
+    end
+    redirect_to url_for( Rails.application.routes.recognize_path( params[:back] ).merge({locale: params[:locale]}) ), notice: I18n.t("messages.locale_changed", locale: params[:locale])
+  end
+  
+  private
+
+    # Never trust parameters from the scary internet, only allow the white list through.
+    def locale_params
+      params.require(:magic_locales_locale).permit(:name, :natural_name, :iso_code, :translations_attributes => [:id, :name, :locale])
+    end
+end
+

data/lib/app/models/magic_locales/association.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+module MagicLocales
+  module Association
+  
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+  
+    ##   C L A S S - M E T H O D S   # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
+    module ClassMethods
+      
+      def has_one_language
+        # send :include, InstanceMethods
+        
+        has_one   :language, 
+                      -> { where(level: 'native', default: true) }, 
+                      as:         :owner, 
+                      class_name: "MagicLocales::Language", 
+                      dependent:  :destroy
+        
+        accepts_nested_attributes_for :language,          allow_destroy: true,    reject_if: :all_blank
+      end
+      
+      
+      def has_languages
+        # send :include, InstanceMethods
+        
+        has_many  :spoken_languages, 
+                      as:         :owner, 
+                      class_name: "MagicLocales::Language", 
+                      dependent: :destroy
+        
+        has_many  :foreign_languages, 
+                      -> { where.not(level: 'native') }, 
+                      as:         :owner, 
+                      class_name: "MagicLocales::Language", 
+                      dependent:  :destroy
+        
+        has_many  :native_languages, 
+                      -> { where(level: 'native') }, 
+                      as:         :owner, 
+                      class_name: "MagicLocales::Language", 
+                      dependent:  :destroy
+        
+        accepts_nested_attributes_for :spoken_languages,  allow_destroy: true,    reject_if: :all_blank
+      end
+      
+      
+    end #> ClassMethods
+  
+    ##   I N S T A N C E - M E T H O D S   # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 
+    module InstanceMethods
+      
+      # ...
+      
+    end #> InstanceMethods
+  
+  end
+end

data/lib/app/models/magic_locales/language.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+class MagicLocales::Language < ActiveRecord::Base
+  
+  # =====> R E W R I T E S <================================================================= #
+  MODEL_PARAMS = [ :id, :locale_id, :level, :_destroy ]
+  
+  # =====> C O N S T A N T S <=============================================================== #
+  LEVELS = %w(basic medium advanced excelent) # => and 'native'
+  
+  # =====> A S S O Z I A T I O N S <========================================================= #
+  belongs_to :user,     class_name: "User",             foreign_key: :user_id
+  belongs_to :locale,   class_name: "Wizard::Locale",   foreign_key: :locale_id
+  
+  
+  # =====> A T T R I B U T E S <============================================================= #
+  delegate   :name, :iso_code, to: :locale, allow_nil: true
+  
+  
+  # =====> V A L I D A T I O N <============================================================= #
+  validates :locale, presence: true
+  
+  
+  # =====> C A L L B A C K S <=============================================================== #
+  # before_validation :clean_up_values
+  
+  
+  # =====> S C O P E S <===================================================================== #
+  
+  # =====> C L A S S - M E T H O D S <======================================================= #
+  
+  # =====> I N S T A N C E - M E T H O D S <================================================= #
+  
+  # =====>  P  R  I  V  A  T  E  !  <======================================================== # # # # # # # #
+private
+  
+  # def clean_up_values
+  #   if self.iso_code.present? && self.iso_code_changed?
+  #     self.iso_code = if self.iso_code.split("-").count > 1
+  #       "#{self.iso_code.split("-")[0].to_s.downcase}-#{self.iso_code.split("-")[1].to_s.upcase}"
+  #     else
+  #       self.iso_code.to_s.downcase
+  #     end
+  #   end
+  # end
+  
+end

data/lib/app/models/magic_locales/locale.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+class MagicLocales::Locale < ActiveRecord::Base
+  
+  # =====> R E W R I T E S <================================================================= #
+  
+  # =====> C O N S T A N T S <=============================================================== #
+  STATES = %w(inactive active live)
+  
+  # =====> A S S O Z I A T I O N S <========================================================= #
+  
+  # =====> A T T R I B U T E S <============================================================= #
+  translates :name, fallbacks_for_empty_translations: true
+  accepts_nested_attributes_for :translations, reject_if: proc { |attributes| attributes['name'].blank? }
+  
+  
+  # =====> V A L I D A T I O N <============================================================= #
+  validates :iso_code, presence: true, length: { in: 2..6 }, format: { with: /\A[a-z]{2}(-[A-Z]{2,3})?\z/ }
+  
+  
+  # =====> C A L L B A C K S <=============================================================== #
+  before_validation :clean_up_values
+  
+  
+  # =====> S C O P E S <===================================================================== #
+  # default_scope { includes(:translations).with_translations(I18n.available_locales).order( 'locale_state ASC, wizard_locale_translations.name ASC' ) } 
+  # default_scope { includes(:translations).with_translations(I18n.locale).order( 'wizard_locale_translations.name ASC' ) } 
+  
+  
+  # =====> C L A S S - M E T H O D S <======================================================= #
+  def self.search(search)
+    if search
+      with_translations.where('name LIKE ?', "%#{search}%")
+    else
+      with_translations
+    end
+  end
+  
+  ## MicroMachine .. (Finite State Machine)
+  def do_transition!( transition )
+    state.trigger( transition.to_sym )
+    self.save
+  end
+
+  def state
+    @state ||= begin
+      fsm = MicroMachine.new(locale_state || "inactive")
+      fsm.when(:activate, "inactive" => "active")
+      fsm.when(:release, "active" => "live")
+      fsm.when(:deactivate, "active" => "inactive", "live" => "inactive")
+      fsm.on(:any) { self.locale_state = state.state }
+      fsm
+    end
+  end
+  
+  
+  # =====> I N S T A N C E - M E T H O D S <================================================= #
+  def with_translations(*locales)
+    locales = translated_locales if locales.empty?
+    includes(:translations).with_locales(locales).with_required_attributes
+  end
+  
+  
+  # =====>  P  R  I  V  A  T  E  !  <======================================================== # # # # # # # #
+private
+  
+  def clean_up_values
+    if self.iso_code.present? && self.iso_code_changed?
+      self.iso_code = if self.iso_code.split("-").count > 1
+        "#{self.iso_code.split("-")[0].to_s.downcase}-#{self.iso_code.split("-")[1].to_s.upcase}"
+      else
+        self.iso_code.to_s.downcase
+      end
+    end
+    
+  end
+  
+  
+end

data/lib/app/models/magic_locales.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module MagicLocales
+  def self.table_name_prefix
+    'mgclang_'
+  end
+end

data/lib/app/views/magic_locales/_locale_switch.html.erb

@@ -0,0 +1,39 @@
+<% tag ||= :div %>
+<% css_class ||= "" %>
+<% show_name ||= false %>
+<% show_arrow ||= false %>
+
+<%# if CONFIG[:allow_locale_change] %>
+<% if system_locales.count > 1 %>
+  
+  <%= content_tag tag, class: "dropdown #{css_class}" do %>
+    <a class="dropdown-toggle" data-toggle="dropdown" href="#">
+      <%= flag() %> 
+      <%#= t("language", locale: I18n.locale.to_s) if show_name %> 
+      <%= get_system_locales.where(iso_code: I18n.locale.to_s).any? ? get_system_locales.where(iso_code: I18n.locale.to_s).first.natural_name : t("language", locale: I18n.locale.to_s) if show_name %>
+      <%= raw('<b class="caret"></b>') if show_arrow %>
+    </a>
+    <ul class="dropdown-menu">
+      <%# CONFIG[:app_locales].each do |lcl| %>
+      <% if 3 == 4 %>
+      <% system_locales.each do |lcl| %>
+        <% if I18n.available_locales.include?(lcl.to_sym) %>
+          <li>
+            <a href="<%= change_locale_path(lcl, back: url_for(locale:nil)) %>"><%= flag(lcl) %> <%= t("language", locale: lcl) %></a>
+          </li>
+        <% end %>
+      <% end %>
+      <% end %>
+      
+      <% get_system_locales.each do |lcl| %>
+        <% if I18n.available_locales.include?(lcl.iso_code.to_sym) %>
+          <li>
+            <a href="<%= change_locale_path(lcl.iso_code, back: url_for(locale:nil)) %>"><%= flag(lcl.iso_code) %> <%= lcl.natural_name %></a>
+          </li>
+        <% end %>
+      <% end %>
+    </ul>
+  <% end %>
+  
+<% end %>
+

data/lib/app/views/magic_locales/locales/_globalized_name_fields.html.erb

@@ -0,0 +1,20 @@
+<% system_locales.each do |lc| %>
+  <%= f.globalize_fields_for lc do |g| %>
+    <div class="row">
+      <div class="col-sm-5">
+        <%= g.label :name do %>
+          <%= locale_flag lc %> Name (<%= lc %>)
+        <% end %>
+      </div>
+      <div class="col-sm-7">
+        <% if (lc == I18n.locale.to_s) && f.object.errors.any? && f.object.errors.keys.include?(:name) %>
+          <div class="field_with_errors">
+            <%= g.text_field :name, class: "form-control" %>
+          </div>
+        <% else %>
+          <%= g.text_field :name, class: "form-control" %>
+        <% end %>
+      </div>
+    </div>
+  <% end %>
+<% end %>

data/lib/app/views/magic_locales/locales/form.html.erb

@@ -0,0 +1,47 @@
+<%# path = @locale.id.present? ? mgclang_locale_path(@locale) : mgclang_locales_path %>
+<% path = @locale.id.present? ? url_for( controller: "magic_locales/locales", action: :update, id: @locale) : url_for( controller: "magic_locales/locales", action: :create ) %>
+
+<%= form_for @locale, url: path  do |f| %>
+
+  <div class="modal-header">
+    <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
+    <h4 class="modal-title" id="appModalLabel">locale</h4>
+  </div>
+  <div class="modal-body">
+    
+    <div class="row">
+      <div class="col-sm-5">
+        <%= f.label :iso_code %>
+      </div>
+      <div class="col-sm-7">
+        <%= f.text_field :iso_code, class: "form-control" %>
+      </div>
+    </div>
+    
+    <% if 3 == 4 %>
+    <div class="row">
+      <div class="col-sm-5">
+        <%= f.label :name %>
+      </div>
+      <div class="col-sm-7">
+        <%= f.text_field :name, class: "form-control" %>
+      </div>
+    </div>
+    <% end %>
+    
+    <br/>
+    
+    <%= render "globalized_name_fields", f: f %>
+    
+    <%#= render "wizard/shared/globalized_name", f: f %>
+    
+    
+  </div>
+  <div class="modal-footer">
+    <button type="button" class="btn btn-default" data-dismiss="modal"><%= t("buttons.close") %></button>
+    <%= f.submit t("buttons.save", default: "Save"), data: { disable_with: 'Submiting...' }, class: "btn btn-primary" %>
+  </div>
+  
+  
+  
+<% end %>