couch_i18n 0.0.3 → 0.0.4

data/README.rdoc

@@ -9,10 +9,7 @@ database type:
 Now all translations are ported to the database. If you change then now in the
 yaml files, they will nolonger be displayed in the website. They should be managed
 in the database. This gem also provides a translation management system. To place this
-in your own design, create a file _app/views/layouts/couch_i18n/application.html.haml_ with the 
-following content:
-  = render :template => '/layouts/application'
-Or create your own really nice template. Let me know if there is a nice layout!
+in your own design, read the layout section.
 Your Gemfile should look like:
   gem 'simply_stored', :git => 'git://github.com/bterkuile/simply_stored.git'
   gem 'couch_i18n'
@@ -20,12 +17,24 @@ Your Gemfile should look like:
 And in your config routes put:
   namespace :couch_i18n do
     root :to => "stores#index"
-    resources :stores
+    resources :stores do
+      collection do
+        post :export
+        post :import
+        delete :destroy_offset
+      end
+    end
   end
 Or to put is at a different location:
   namespace :translations, :module => :couch_i18n, :as => 'couch_i18n' do
     root :to => "stores#index"
-    resources :stores
+    resources :stores do
+      collection do
+        post :export
+        post :import
+        delete :destroy_offset
+      end
+    end
   end
 The intention is to make this a mountable application, but this will not happen 
 before Rails 3.1 is officially out. But beware of using this if your application
@@ -52,16 +61,118 @@ initializer: _config/initializers/couch_I18n_modifications.rb_
   end
 And in _config/authorization_rules.rb_ put your personalized version of:
   role :translator do
-    has_permission_on :couch_i18n_stores, :to => :manage
+    has_permission_on :couch_i18n_stores, :to => [:manage, :import, :export, :destroy_offset]
   end
 Beware that a permission denied message will appear when the server is restarted
 this way. This is because the current user is set in ApplicationController which
 is not part of the CouchI18n controller stack.
 
+== couch_i18n translations
+Ofcourse couch_i18n is working with translations as well. To get them working import
+the following yamlL
+  en:
+    New: New
+    Edit: Edit
+    Show: Show
+    Back: Back
+    Save: Save
+    Create: Create
+    Are you sure: 'Are you sure?'
+    activemodel:
+      models:
+        couch_i18n:
+          store: Translation
+      attributes:
+        couch_i18n:
+          store:
+            key: Key
+            value: Value
+    action:
+      create:
+        successful: %{model} successfully created
+      update:
+        successful: %{model} successfully updated
+      destroy:
+        successful: %{model} successfully removed
+    chouch_i18n: 
+      store:
+        index title: Translations
+        none found: No translations present
+        new title: New translation
+        show title: Translation
+        edit title: Edit translation
+        go to offset: Go to
+        got to zero offset: x
+        export: Export
+        import: Import
+        offset deleted: "%{count} translations with offset %{offset} are deleted"
+        no proper import extension: Files with extension%{extension} cannot be imported
+        no import file given: There is no file to be imported
+        cannot parse yaml: The file cannot be read
+        file imported: File %{filename} was successfully imported
+        # The following tranlation will only work if no are_you_sure helper is present
+        are you sure: 'Are you sure?'
+        destroy offset link: Delete all translations with current offset
+        # The following tranlation will only work if no site_title helper is present
+        site_title: Translations
+== couch_i18n helpers
+The following helpers are assumed:
+  module CouchI18nViewHelpers
+    def title(str)
+      content_for :title do
+        content_tag(:h1, str)
+      end
+    end
+    def link_to_new_content(obj)
+      t('New')
+    end
+    def link_to_edit_content(obj = nil)
+      t('Edit')
+    end
+    def link_to_show_content(obj = nil)
+      t('Show')
+    end
+    def link_to_index_content(singular_name)
+      t('Back')
+    end
+    def link_to_destroy_content(obj = nil)
+      t('Delete')
+    end
+    def update_button_text(obj = nil)
+      t('Save')
+    end
+    def create_button_text(obj = nil)
+      t('Create')
+    end
+    def boolean_text(truefalse)
+      truefalse ? t('boolean true') : t('boolean false')
+    end
+    def are_you_sure(obj = nil)
+      t('Are you sure')
+    end
+  end
+
+== couch_i18n layout
+This gem comes with its own layout file, but you can ofcourse use your own. To do this place a layout at your application with the 
+path: <tt>app/views/layouts/couch_i18n/application.html.haml</tt>
+It should <tt>yield</tt> the following parts:
+  !!!
+  %html
+    %head
+      %title= defined?(site_title) ? site_title : I18n.t('couch_i18n.store.site_title')
+      = csrf_meta_tag
+      = yield :head
+    %body
+      #page-wrapper
+        #page-content
+          %h1= yield :title
+          = yield
+          #page-links= yield :page_links
 == TODO
 Here my todo list for this project. Makes it insightful for everybody what is on
 the planning of being made.
 * Check on locale inclusion with are you sure? force creation of new locale. Mostly a stupic mistake omitting these.
-* Add grouped deletes. Dangerous, but controllable using the declarative_authorization example
 * Add grouped search/replaces to move one group of translations to another section. Same comment as above
 * Search through values. If anyone has a better idea than searching by ruby through all the translations or adding lucene please feel free.
+* A lot of testing
+* Add error_messages partial to manual

data/app/controllers/couch_i18n/stores_controller.rb

@@ -11,7 +11,7 @@ module CouchI18n
             :offset => @levels[0..i].join('.')
           }
         end
-        @couch_i18n_stores = CouchI18n::Store.find_all_by_key("#{params[:offset]}.".."#{params[:offset]}.\u9999", :page => params[:page], :per_page => 30)
+        @couch_i18n_stores = CouchI18n::Store.with_offset(params[:offset], :page => params[:page], :per_page => 30)
         @available_deeper_offsets = CouchI18n::Store.get_keys_by_level(@levels.size, :startkey => @levels, :endkey => @levels + [{}]).
           map{|dl| {:name => dl, :offset => [params[:offset], dl].join('.')}}
       else
@@ -37,9 +37,13 @@ module CouchI18n
         render :action => :new
       end
     end
+
+    # GET /couch_i18n/stores/:id/edit
     def edit
       @couch_i18n_store = CouchI18n::Store.find(params[:id])
     end
+
+    # PUT /couch_i18n/stores/:id
     def update
       @couch_i18n_store = CouchI18n::Store.find(params[:id])
       if @couch_i18n_store.update_attributes(params[:couch_i18n_store])
@@ -56,5 +60,68 @@ module CouchI18n
       end
       redirect_to({:action => :index, :offset => @couch_i18n_store.key.to_s.sub(/\.\w+$/, '')})
     end
+
+    # POST /couch_i18n/stores/export
+    # Export to yml, csv or json
+    def export
+      if params[:offset].present?
+        @couch_i18n_stores = CouchI18n::Store.with_offset(params[:offset])
+      else
+        @couch_i18n_stores = CouchI18n::Store.all
+      end
+      base_filename = "export#{Time.now.strftime('%Y%m%d%H%M')}"
+      if params[:exportformat] == 'csv'
+        response.headers['Content-Type'] = 'text/csv'
+        response.headers['Content-Disposition'] = %{attachment; filename="#{base_filename}.csv"}
+        render :text => @couch_i18n_stores.map{|s| [s.key, s.value.to_json].join(',')}.join("\n")
+      elsif params[:exportformat] == 'json'
+        response.headers['Content-Type'] = 'application/json'
+        response.headers['Content-Disposition'] = %{attachment; filename="#{base_filename}.json"}
+        # render :text => CouchI18n.indent_keys(@couch_i18n_stores).to_json # for indented json
+        render :json => @couch_i18n_stores.map{|s| {s.key => s.value}}.to_json
+      else #yaml
+        response.headers['Content-Type'] = 'application/x-yaml'
+        response.headers['Content-Disposition'] = %{attachment; filename="#{base_filename}.yml"}
+        render :text => CouchI18n.indent_keys(@couch_i18n_stores).to_yaml
+      end
+    end
+
+    # POST /couch_i18n/stores/import
+    # Import yml files
+    def import
+      redirect_to({:action => :index, :offset => params[:offset]}, :alert => I18n.t('couch_i18n.store.no import file given')) and return unless params[:importfile].present?
+      filename = params[:importfile].original_filename
+      extension = filename.sub(/.*\./, '')
+      if extension == 'yml'
+        hash = YAML.load_file(params[:importfile].tempfile.path) rescue nil
+        redirect_to({:action => :index, :offset => params[:offset]}, :alert => I18n.t('couch_i18n.store.cannot parse yaml')) and return unless hash
+        CouchI18n.traverse_flatten_keys(hash).each do |key, value|
+          existing = CouchI18n::Store.find_by_key(key)
+          if existing
+            if existing.value != value
+              existing.value = value
+              existing.save
+            end
+          else
+            CouchI18n::Store.create :key => key, :value => value
+          end
+        end 
+      else
+        redirect_to({:action => :index, :offset => params[:offset]}, :alert => I18n.t('couch_i18n.store.no proper import extension', :extension => extension)) and return 
+      end
+      redirect_to({:action => :index, :offset => params[:offset]}, :notice => I18n.t('couch_i18n.store.file imported', :filename => filename))
+    end
+
+    # Very dangarous action, please handle this with care, large removals are supported!
+    # DELETE /couch_i18n/stores/destroy_offset?...
+    def destroy_offset
+      if params[:offset].present?
+        @couch_i18n_stores = CouchI18n::Store.with_offset(params[:offset])
+      else
+        @couch_i18n_stores = CouchI18n::Store.all
+      end
+      @couch_i18n_stores.map(&:destroy)
+      redirect_to({:action => :index}, :notice => I18n.t('couch_i18n.store.offset deleted', :count => @couch_i18n_stores, :offset => params[:offset]))
+    end
   end
 end

data/app/views/couch_i18n/stores/_form.html.haml

@@ -5,6 +5,6 @@
     = f.text_field :key, :size => 70
   .field
     = f.label :value
-    = f.text_field :value
+    = f.text_field :value, :size => 70
   .actions
     = f.submit @submit || update_button_text

data/app/views/couch_i18n/stores/edit.html.haml

@@ -1,4 +1,4 @@
-- title t("couch_i18n.store.Edit title")
+- title t("couch_i18n.store.edit title")
 = render 'form'
 - content_for :page_links do
   = link_to link_to_index_content(:couch_i18n_stores), couch_i18n_stores_path(:offset => params[:offset] || @couch_i18n_store.key.to_s.sub(/\.[\w\s-]+$/, ''))

data/app/views/couch_i18n/stores/index.html.haml

@@ -1,14 +1,29 @@
-- title t("couch_i18n.store.Index title")
-- for offset in @available_higher_offsets
-  = link_to offset[:name], :offset => offset[:offset]
-= form_tag({}, :method => :get )do
-  - if params[:offset].present?
-    = link_to 'x', :offset => nil
-  = text_field_tag :offset, params[:offset], :size => 60
-  = "(#{@couch_i18n_stores.total_entries})"
-  = submit_tag 'Select offset'
-- for offset in @available_deeper_offsets
-  = link_to offset[:name], :offset => offset[:offset]
+- title t("couch_i18n.store.index title")
+.destroy-link
+  = link_to t('couch_i18n.store.destroy offset link'), destroy_offset_couch_i18n_stores_path(:offset => params[:offset]), :method => :delete, :confirm => (defined?(:are_you_sure) ? are_you_sure : t('couch_i18n.store.are you sure'))
+.import-form
+  = form_tag({:action => :import}, :multipart => true) do
+    = file_field_tag :importfile
+    = submit_tag I18n.t('couch_i18n.store.import')
+.export-form
+  = form_tag :action => :export do
+    = hidden_field_tag :offset, params[:offset]
+    = select_tag :exportformat, options_for_select(%w[yml csv json], params[:exportformat])
+    = submit_tag I18n.t('couch_i18n.store.export')
+.offset-navigation-block.block
+  .offset-navigation-higher
+    - for offset in @available_higher_offsets
+      = link_to offset[:name], :offset => offset[:offset]
+  .offset-navigation-form
+    = form_tag({}, :method => :get )do
+      - if params[:offset].present?
+        = link_to I18n.t('couch_i18n.store.go to zero offset'), :offset => nil
+      = text_field_tag :offset, params[:offset], :size => 60
+      = "(#{@couch_i18n_stores.total_entries})"
+      = submit_tag I18n.t('couch_i18n.store.go to offset')
+  .offset-navigation-deeper
+    - for offset in @available_deeper_offsets
+      = link_to offset[:name], :offset => offset[:offset]
 - if @couch_i18n_stores.any?
   = paginate @couch_i18n_stores, :right => 3, :left => 3
   %table.index-table
@@ -25,7 +40,7 @@
           %td= link_to link_to_edit_content(couch_i18n_store), edit_couch_i18n_store_path(couch_i18n_store)
           %td= link_to link_to_destroy_content(couch_i18n_store),couch_i18n_store_path(couch_i18n_store), :confirm => are_you_sure, :method => :delete
 - else
-  %h3= t("couch_i18n_store.None found")
+  %h3= t("couch_i18n_store.none found")
 
 - content_for :page_links do
   = link_to link_to_new_content(:couch_i18n_store), new_couch_i18n_store_path(:offset => params[:offset])

data/app/views/couch_i18n/stores/new.html.haml

@@ -1,4 +1,4 @@
-- title t("couch_i18n.store.New title")
+- title t("couch_i18n.store.new title")
 = render 'form'
 - content_for :page_links do
   = link_to link_to_index_content(:couch_i18n_stores), couch_i18n_stores_path(:offset => params[:offset])

data/lib/couch_i18n/backend.rb

@@ -0,0 +1,99 @@
+require 'i18n/backend/base'
+require 'active_support/json'
+require 'active_support/ordered_hash' # active_support/json/encoding uses ActiveSupport::OrderedHash but does not require it
+
+module CouchI18n
+  class Backend
+    # This is a basic backend for key value stores. It receives on
+    # initialization the store, which should respond to three methods:
+    #
+    # * store#[](key)         - Used to get a value
+    # * store#[]=(key, value) - Used to set a value
+    # * store#keys            - Used to get all keys
+    #
+    # Since these stores only supports string, all values are converted
+    # to JSON before being stored, allowing it to also store booleans,
+    # hashes and arrays. However, this store does not support Procs.
+    #
+    # As the ActiveRecord backend, Symbols are just supported when loading
+    # translations from the filesystem or through explicit store translations.
+    #
+    # Also, avoid calling I18n.available_locales since it's a somehow
+    # expensive operation in most stores.
+    #
+    # == Example
+    #
+    # To setup I18n to use TokyoCabinet in memory is quite straightforward:
+    #
+    #   require 'rufus/tokyo/cabinet' # gem install rufus-tokyo
+    #   I18n.backend = I18n::Backend::KeyValue.new(Rufus::Tokyo::Cabinet.new('*'))
+    #
+    # == Performance
+    #
+    # You may make this backend even faster by including the Memoize module.
+    # However, notice that you should properly clear the cache if you change
+    # values directly in the key-store.
+    #
+    # == Subtrees
+    #
+    # In most backends, you are allowed to retrieve part of a translation tree:
+    #
+    #   I18n.backend.store_translations :en, :foo => { :bar => :baz }
+    #   I18n.t "foo" #=> { :bar => :baz }
+    #
+    # This backend supports this feature by default, but it slows down the storage
+    # of new data considerably and makes hard to delete entries. That said, you are
+    # allowed to disable the storage of subtrees on initialization:
+    #
+    #   I18n::Backend::KeyValue.new(@store, false)
+    #
+    # This is useful if you are using a KeyValue backend chained to a Simple backend.
+    module Implementation
+      attr_accessor :store
+
+      include I18n::Backend::Base, I18n::Backend::Flatten
+
+      def initialize(store, subtrees=true)
+        @store, @subtrees = store, subtrees
+      end
+
+      def store_translations(locale, data, options = {})
+        escape = options.fetch(:escape, true)
+        flatten_translations(locale, data, escape, @subtrees).each do |key, value|
+          key = "#{locale}.#{key}"
+
+          case value
+          when Hash
+            if @subtrees && (old_value = @store[key])
+              old_value = ActiveSupport::JSON.decode(old_value)
+              value = old_value.deep_symbolize_keys.deep_merge!(value) if old_value.is_a?(Hash)
+            end
+          when Proc
+            raise "Key-value stores cannot handle procs"
+          end
+
+          @store[key] = ActiveSupport::JSON.encode(value) unless value.is_a?(Symbol)
+        end
+      end
+
+      def available_locales
+        locales = @store.keys.map { |k| k =~ /\./; $` }
+        locales.uniq!
+        locales.compact!
+        locales.map! { |k| k.to_sym }
+        locales
+      end
+
+    protected
+
+      def lookup(locale, key, scope = [], options = {})
+        key   = normalize_flat_keys(locale, key, scope, options[:separator])
+        value = @store["#{locale}.#{key}"]
+        #value = ActiveSupport::JSON.decode(value) if value
+        value.is_a?(Hash) ? value.deep_symbolize_keys : value
+      end
+    end
+
+    include Implementation
+  end
+end

data/lib/couch_i18n/store.rb

@@ -45,6 +45,11 @@ module CouchI18n
       translation.save
     end
 
+    # Shorthand for selecting all stored with a given offset
+    def self.with_offset(offset, options = {})
+      find_all_by_key("#{offset}.".."#{offset}.ZZZZZZZZZ", options)
+    end
+
     # alias for read
     def self.[](key, options=nil)
       find_by_key(key.to_s).try(:value) rescue nil

data/lib/couch_i18n.rb

@@ -1,6 +1,7 @@
 require "i18n/backend/cache"
 require "couch_i18n/engine"
 require 'couch_i18n/store'
+require 'couch_i18n/backend'
 I18n::Backend::KeyValue.send(:include, I18n::Backend::Cache)
 module CouchI18n
   # This method imports yaml translations to the couchdb version. When run again new ones will
@@ -12,27 +13,49 @@ module CouchI18n
 
     raise "Last backend not a I18n::Backend::Simple" unless yml_backend.is_a?(I18n::Backend::Simple)
     yml_backend.load_translations
-    flattened_hash = traverse_flatten_keys({}, yml_backend.send(:translations))
+    flattened_hash = traverse_flatten_keys(yml_backend.send(:translations))
     flattened_hash.each do |key, value|
       CouchI18n::Store.create :key => key, :value => value
     end
   end
 
   # Recursive flattening.
-  def self.traverse_flatten_keys(store, obj, path = nil)
+  def self.traverse_flatten_keys(obj, store = {}, path = nil)
     case obj
     when Hash
-     obj.each{|k, v| traverse_flatten_keys(store, v, [path, k].compact.join('.'))}
+     obj.each{|k, v| traverse_flatten_keys(v, store, [path, k].compact.join('.'))}
     when Array
-      store[path] = obj.to_json
-      #obj.each_with_index{|v, i| traverse_flatten_keys(store, v, [path, i].compact.join('.'))}
+      # Do not store array for now. There is no good solution yet
+      # store[path] = obj # Keeyp arrays intact
+      # store[path] = obj.to_json
+      # obj.each_with_index{|v, i| traverse_flatten_keys(store, v, [path, i].compact.join('.'))}
     else
       store[path] = obj
     end
     return store
   end
+
+  # This will return an indented strucutre of a collection of stores. If no argument is given
+  # by default all the translations are indented. So a command:
+  #   CouchI18n.indent_keys.to_yaml will return one big yaml string of the translations
+  def self.indent_keys(selection = Store.all)
+    traverse_indent_keys(selection.map{|kv| [kv.key.split('.'), kv.value]})
+  end
+
+  # Traversing helper for indent_keys
+  def self.traverse_indent_keys(ary, h = {})
+    for pair in ary
+      if pair.first.size == 1
+        h[pair.first.first] = pair.last
+      else
+        h[pair.first.first] ||= {}
+        traverse_indent_keys([[pair.first[1..-1], pair.last]], h[pair.first.first])
+      end
+    end
+    h
+  end
 end
 
 # Now extend the I18n backend
-I18n.backend = I18n::Backend::Chain.new(I18n::Backend::KeyValue.new(CouchI18n::Store), I18n.backend)
+I18n.backend = I18n::Backend::Chain.new(CouchI18n::Backend.new(CouchI18n::Store), I18n.backend)
 I18n.cache_store = ActiveSupport::Cache.lookup_store(:memory_store)

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: couch_i18n
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors: 
 - Benjamin ter Kuile
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 +02:00
+date: 2011-05-21 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -28,6 +24,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/couch_i18n/engine.rb
+- lib/couch_i18n/backend.rb
 - lib/couch_i18n/store.rb
 - lib/couch_i18n.rb
 - lib/tasks/couch_i18n_tasks.rake
@@ -54,23 +51,21 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: couch_i18n
-rubygems_version: 1.3.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: couch_i18n is an in database storage for I18n translations, tested for rails, with online management views