inplace_i18n 0.0.1

data/.gitignore

@@ -0,0 +1,16 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rails", "3.2.3"

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    inplace_i18n (0.0.1)
+      ya2yaml
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.3)
+      actionpack (= 3.2.3)
+      mail (~> 2.4.4)
+    actionpack (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    json (1.7.1)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    multi_json (1.3.4)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.3)
+      actionmailer (= 3.2.3)
+      actionpack (= 3.2.3)
+      activerecord (= 3.2.3)
+      activeresource (= 3.2.3)
+      activesupport (= 3.2.3)
+      bundler (~> 1.0)
+      railties (= 3.2.3)
+    railties (3.2.3)
+      actionpack (= 3.2.3)
+      activesupport (= 3.2.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    ya2yaml (0.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  inplace_i18n!
+  rails (= 3.2.3)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Gregory Tangey
+
+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,66 @@
+# inplace_i18n
+
+## About
+
+Add/Edit Translations inside your application by using this gem and mounting its rails engine.
+
+It makes a few assumptions:
+* you use **yaml for translations**
+* your **translations are stored in [locale].yml**
+
+It does a few things you might not like:
+* it re-arranges your [locale].yml alphabetically by key
+* there's ZERO security, anyone can and will play with your translations. Don't be a production dummy.
+
+## Why?
+
+I hate trawling through translation files.
+
+## Usage
+
+Using inplace_i18n with rails is pretty straight forward, drop this into your Gemfile:
+
+    group :development do
+      gem 'inplace_i18n', git: 'git://github.com/Ruxton/inplace_i18n.git'
+    end
+
+Then add the javascript and stylesheets to your project, there are 2 helper methods for this.  In your head place the stylesheet:
+
+    %head
+      = inplace_i18n_stylesheets
+
+And wherever you put your javascript:
+
+    = inplace_i18n_js
+
+Alternatively you can add them to your existing assets using the asset pipeline:
+
+    @import inplace_i18n/inplace_i18n_styles
+
+and:
+
+    #= require inplace_i18n/inplace_i18n
+
+Finally, mount the engine somewhere in your applications config/routes.rb file:
+
+    mount InplaceI18n::Engine => '/translate'
+
+An 'Edit Translations' button will show up in the top right hand corner of your site, clicking it will overlay pencil icons above every translation.  Clicking on the pencil will allow you to edit that translation.
+
+If you have translations inside the attributes of a HTML Element, pass inplace: false as an option to the translation and the editor wont be added for that translation.  Currently adding it these will cause your HTML to break.
+
+    image_tag 'awesome-image.png', alt: t('.awesome_image_alt', inplace: false)
+
+
+## Thanks, Kudos & Legalities
+
+* Implementation idea & some code adopted from [i18n_locale_editor](http://github.com/n1k/i18n_locale_editor/)
+* Edit icon c/o [FamFam Silk Iconset](http://www.famfamfam.com/lab/icons/silk/)
+
+## Copyright
+
+Copyright (c) 2011 [Gregory Tangey](http://ignite.digitalignition.net/). See LICENSE for details.
+
+
+
+

data/app/assets/javascripts/inplace_i18n/inplace_i18n.js.coffee.erb

@@ -0,0 +1,50 @@
+jQuery ($) ->
+  addTranslationButton()
+  registerTranslationClick()
+
+addTranslationButton = () ->
+  $('body').append '<div id="inplace_i18n">Edit Translations</div>'
+  target = $('#inplace_i18n')
+  target.on 'click', (e) ->
+    e.preventDefault
+    $('span.inplace_i18n').toggle()
+
+inplaceI18nUrl = (key) ->
+  <%
+    path = InplaceI18n::Engine.routes.url_helpers.translation_path('1')
+  %>
+  url = '<%= path %>'
+  url = url.replace('/1','/'+key)
+  return url
+
+updateTranslation = (key,value) ->
+
+  url = inplaceI18nUrl(key)
+
+  if value? and key?
+    request = $.ajax
+      type: "PUT"
+      url: url
+      data:
+        value: value
+
+      async: true
+      success: ->
+        console.log 'Success'
+
+      error: ->
+        alert "error posting data to url:" + url
+
+registerTranslationClick = () ->
+  $('span.inplace_i18n').on 'click', (e) ->
+    e.preventDefault()
+    key = e.srcElement.id
+    url = inplaceI18nUrl(key)
+
+    request = $.ajax
+      type: "GET"
+      url: url
+
+    request.success (msg) ->
+      a = prompt('Translation',request.responseText)
+      updateTranslation(key,a)

data/app/assets/stylesheets/inplace_i18n/inplace_i18n_styles.sass

@@ -0,0 +1,64 @@
+.i18n_translation
+  position: relative
+  width: 0px
+  height: 0px
+  .inplace_i18n
+    display: none
+    width: 16px
+    height: 16px
+    position: absolute
+    top: -20px
+    right: -20px
+    z-index: 99999999
+
+    background: #e3e3e3
+    background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAFUSURBVDjLrZM/SAJxGIZdWwuDlnCplkAEm1zkaIiGFFpyMIwGK5KGoK2lphDKkMDg3LLUSIJsSKhIi+684CokOtTiMizCGuzEU5K3vOEgKvtBDe/2Pc8H3x8NAM1fQlx4H9M3pcOWp6TXWmM8A7j0629v1nraiAVC0IrrwATKIgs5xyG5QiE+Z4iQdoeU2oAsnqCSO1NSTu+D9VhqRLD8nIB8F0Q2MgmJDyipCzjvYJkIfpN2UBLG8MpP4dxvQ3ZzGuyyBQ2H+AnOOCBd9aL6soh81A5hyYSGWyCFvxUcerqI4S+CvYVOFPMHxLAq8I3qdHVY5LbBhJzEsCrwutpRFBlUHy6wO2tEYtWAzLELPN2P03kjfj3luqDycV2F8AgefWbEnVqEHa2IznSD6BdsVDNStB0lfh0FPoQjdx8RrAqGzC0YprSgxzsUMOY2bf37N/6Ud1Vc9yYcH50CAAAAAElFTkSuQmCC)
+    border: 1px solid #bbb
+    -webkit-border-radius: 3px
+    -moz-border-radius: 3px
+    border-radius: 3px
+    -webkit-box-shadow: inset 0 0 1px 1px #f6f6f6
+    -moz-box-shadow: inset 0 0 1px 1px #f6f6f6
+    box-shadow: inset 0 0 1px 1px #f6f6f6
+    color: #333
+    font: bold 12px "helvetica neue", helvetica, arial, sans-serif
+    height: 16px
+    width: 16px
+    text-align: center
+    text-shadow: 0 1px 0 #fff
+
+#inplace_i18n
+  position: absolute
+  top: 10px
+  right: 20px
+  display: block
+  z-index: 99999999
+
+  background: #e3e3e3
+  border: 1px solid #bbb
+  -webkit-border-radius: 3px
+  -moz-border-radius: 3px
+  border-radius: 3px
+  -webkit-box-shadow: inset 0 0 1px 1px #f6f6f6
+  -moz-box-shadow: inset 0 0 1px 1px #f6f6f6
+  box-shadow: inset 0 0 1px 1px #f6f6f6
+  color: #333
+  font: bold 12px "helvetica neue", helvetica, arial, sans-serif
+  line-height: 1
+  padding: 8px 0 9px
+  text-align: center
+  text-shadow: 0 1px 0 #fff
+  width: 150px
+  &:hover
+    background: #d9d9d9
+    -webkit-box-shadow: inset 0 0 1px 1px #eaeaea
+    -moz-box-shadow: inset 0 0 1px 1px #eaeaea
+    box-shadow: inset 0 0 1px 1px #eaeaea
+    color: #222
+    cursor: pointer
+  &:active
+    background: #d0d0d0
+    -webkit-box-shadow: inset 0 0 1px 1px #e3e3e3
+    -moz-box-shadow: inset 0 0 1px 1px #e3e3e3
+    box-shadow: inset 0 0 1px 1px #e3e3e3
+    color: #000

data/app/controllers/inplace_i18n/translations_controller.rb

@@ -0,0 +1,25 @@
+module InplaceI18n
+  class TranslationsController < ApplicationController
+
+    before_filter :set_language
+
+    def show
+      value = Translation.all(@language).find_by_path(params[:path])
+      render :text => value
+    end
+
+    def update
+      Translation.update_by_path(@language, params[:path], params[:value])
+      I18n.reload!
+      render :text => "OK"
+    end
+
+    private
+
+    def set_language
+      @language = params[:path].split(".").first if not params[:path].nil?
+    end
+
+  end
+
+end

data/app/model/inplace_i18n/translation.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'ya2yaml'
+require 'fileutils'
+
+class InplaceI18n::Translation
+
+  def self.all(locale)
+    locale = locale.to_s
+    file = File.join(Rails.root, "config/locales","#{locale}.yml")
+    hash = YAML::load_file file
+  end
+
+  def self.update_by_path(locale,path,value)
+    locale = locale.to_s
+
+    file = File.join(Rails.root, "config/locales","#{locale}.yml")
+    hash = YAML::load_file file
+    hash.update_by_path(path,value)
+    File.open(file + ".new",'w') do |f|
+        f.puts hash.ya2yaml
+    end
+    FileUtils.mv(file + ".new", file)
+  end
+
+  def self.merge_locales locales_array, only_missing = false
+    #available_locales = I18n.available_locales.map{|loc| loc.to_s}
+    #locales_array.each{|loc| raise "#{loc} locale not found" if not available_locales.include? loc.to_s }
+
+    paths = []
+    translations = {}
+    locales_array.each do |locale|
+      translations[locale] = translation = Translation.all(locale)
+      paths = paths + translation.paths.map{|path| path.gsub(/^#{locale.to_s}\./,"")}
+    end
+    paths = paths.uniq
+
+    aggreg = {}
+    paths.each do |path|
+      aggreg[path] = {}
+      locales_array.each do |locale|
+        aggreg[path][locale] = translations[locale].find_by_path(locale.to_s + '.' + path)
+      end
+    end
+    if only_missing
+      return aggreg.delete_if do |path,translation|
+        ret = true
+        translation.each do |language, value|
+           ret = false if value.blank?
+        end
+
+        ret
+      end
+    else
+      return aggreg
+    end
+
+  end
+end

data/app/views/inplace_i18n/_js.erb

@@ -0,0 +1 @@
+<%= javascript_include_tag 'inplace_i18n/inplace_i18n' %>

data/app/views/inplace_i18n/_styles.erb

@@ -0,0 +1 @@
+<%= stylesheet_link_tag 'inplace_i18n/inplace_i18n_styles' %>

data/config/routes.rb

@@ -0,0 +1,4 @@
+InplaceI18n::Engine.routes.draw do
+  put '/translations/:path', as: :translation, controller: :translations, to: :update, :constraints => { :path => /[\w.]+?/, format: false }
+  get '/translations/:path', as: :translation, controller: :translations, to: :show, :constraints => { :path => /[\w.]+?/ , format: false }
+end

data/inplace_i18n.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "inplace_i18n/version"
+
+Gem::Specification.new do |s|
+  s.name = "inplace_i18n"
+  s.summary = "Inplace editing for rails i18n."
+  s.description = "inplace_i18n is an Engine that provides Inplace editing for rails i18n."
+  s.version = InplaceI18n::VERSION
+
+  s.authors     = ["Ruxton"]
+  s.email       = ["ruxton@thefrontiergroup.com.au"]
+  s.homepage    = "http://ignite.digitalignition.net/"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.rubyforge_project = "inplace_i18n"
+
+  s.add_dependency "ya2yaml"
+end

data/lib/inplace_i18n.rb

@@ -0,0 +1,5 @@
+require "inplace_i18n/version"
+
+module InplaceI18n
+  require 'inplace_i18n/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+end

data/lib/inplace_i18n/engine.rb

@@ -0,0 +1,22 @@
+require 'inplace_i18n'
+
+module InplaceI18n
+
+  class Engine < ::Rails::Engine
+    isolate_namespace InplaceI18n
+
+    require 'inplace_i18n/hash_tools'
+    Hash.send :include, InplaceI18n::HashTools
+
+    initializer 'inplace_i18n.register_view_helper' do
+      require 'inplace_i18n/helpers/action_view'
+      ActionView::Base.send :include, InplaceI18n::Helpers::ActionView
+    end
+
+    initializer "inplace_i18n.install_translation_helper", after: 'i18n.callbacks'  do
+      require 'inplace_i18n/translation_helper'
+      ActionView::Helpers::TranslationHelper.send :include, InplaceI18n::TranslationHelper
+    end
+  end
+
+end

data/lib/inplace_i18n/hash_tools.rb

@@ -0,0 +1,100 @@
+module InplaceI18n
+  module HashTools
+
+    def find_by_path(path)
+      e ="self"
+      path_to_a(path).each{|i| e = e+"['"+ escape_for_eval(i)+ "']" }
+      begin
+        eval(e)
+      rescue NoMethodError
+        return nil
+      end
+    end
+
+    def update_by_path(path, string)
+      return false if find_by_path(path).class == "Hash"
+      create_path_if_not_exist(path)
+      e ="self"
+      path_a = path_to_a(path)
+      path_a.each{|i| e = e+"['"+escape_for_eval(i)+"']" }
+      string = string.gsub(/^[ \t]+/,"")
+
+      string = escape_for_eval(string)
+      e = e+"='"+string+"'"
+      begin
+        eval(e)
+        return true
+      rescue => e
+        return [false, e]
+     end
+    end
+
+    def update_by_path_wo_parents(path, string)
+      return false if find_by_path(path).class.to_s == "Hash" && find_by_path(path).length > 0
+      e ="self"
+      path_a = path_to_a(path)
+      path_a.each{|i| e = e+"['"+ escape_for_eval(i)+"']" }
+      string = escape_for_eval(string)
+      e = e+"="+string.inspect+""
+
+      begin
+        eval(e)
+        return true
+      rescue
+        return false
+      end
+    end
+
+    def create_empty_node(path)
+      return false if not find_by_path(path).nil?
+      update_by_path_wo_parents(path, {})
+    end
+
+    def create_path_if_not_exist(path)
+      aa = path_to_a(path)
+      new_aa = []
+      aa.each do |a|
+        new_aa << a
+        create_empty_node(a_to_path(new_aa))
+      end
+    end
+
+    def nodes_array(path = [])
+      ret = []
+      self.each do |key,value|
+        if value.class == Hash
+          ret = ret + value.nodes_array(path + [key])
+        else
+          ret << path + [key]
+        end
+      end
+      ret
+    end
+
+    def next_path(path)
+      paths = self.paths
+      paths[paths.index(path) + 1]
+    end
+
+    def previous_path(path)
+      paths = self.paths
+      paths[paths.index(path) - 1]
+    end
+
+    private
+    def path_to_a(string)
+      string.split(".")
+    end
+
+    def a_to_path(array)
+      array.join(".")
+    end
+
+    def escape_for_eval(string)
+      string.gsub!("'", "\\\\'") if string.class == String
+      string
+    end
+  end
+end
+
+Hash.send(:include, InplaceI18n::HashTools)

data/lib/inplace_i18n/helpers/action_view.rb

@@ -0,0 +1,17 @@
+module InplaceI18n
+  module Helpers
+    module ActionView
+
+      extend ActiveSupport::Concern
+
+      def inplace_i18n_js
+        render 'inplace_i18n/js'
+      end
+
+      def inplace_i18n_styles
+        render 'inplace_i18n/styles'
+      end
+
+    end
+  end
+end

data/lib/inplace_i18n/translation_helper.rb

@@ -0,0 +1,27 @@
+module InplaceI18n
+  module TranslationHelper
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method_chain :translate, :inplace_editing
+      alias :t :translate_with_inplace_editing
+    end
+
+    def translate_with_inplace_editing(key, options = {})
+      key = scope_key_by_partial(key).to_s
+      inplace = true
+      inplace = options[:inplace] unless options.blank?
+
+      translation = translate_without_inplace_editing(key, options)
+
+      if inplace
+        key = I18n.locale.to_s + '.'+key
+        translation = " " if translation.blank?
+        translation = '<span class="i18n_translation"><span id="'+key+'" class="inplace_i18n"></span></span>' + translation
+      end
+
+      translation.html_safe
+
+    end
+  end
+end

data/lib/inplace_i18n/version.rb

@@ -0,0 +1,3 @@
+module InplaceI18n
+  VERSION = "0.0.1"
+end

data/lib/tasks/inplace_i18n_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_blog_engine do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: inplace_i18n
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ruxton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ya2yaml
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: inplace_i18n is an Engine that provides Inplace editing for rails i18n.
+email: 
+- ruxton@thefrontiergroup.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- app/assets/javascripts/inplace_i18n/inplace_i18n.js.coffee.erb
+- app/assets/stylesheets/inplace_i18n/inplace_i18n_styles.sass
+- app/controllers/inplace_i18n/translations_controller.rb
+- app/model/inplace_i18n/translation.rb
+- app/views/inplace_i18n/_js.erb
+- app/views/inplace_i18n/_styles.erb
+- config/routes.rb
+- inplace_i18n.gemspec
+- lib/inplace_i18n.rb
+- lib/inplace_i18n/engine.rb
+- lib/inplace_i18n/hash_tools.rb
+- lib/inplace_i18n/helpers/action_view.rb
+- lib/inplace_i18n/translation_helper.rb
+- lib/inplace_i18n/version.rb
+- lib/tasks/inplace_i18n_tasks.rake
+homepage: http://ignite.digitalignition.net/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: inplace_i18n
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Inplace editing for rails i18n.
+test_files: []
+