whowish_word 0.6.5 → 1.0.0

data/.gitignore

@@ -1,8 +1,8 @@
-
 /Gemfile.lock
 spec/rails/tmp/*
 *.gem
 rails/db/*.sqlite3
 rails/tmp/*
 rails/.bundle/*
-.bundle/*
+.bundle/*
+.rvmrc

data/Gemfile

@@ -1,4 +1,2 @@
-source 'http://rubygems.org'
-
-gem 'rubyzip'
-gem 'rspec'
+source 'https://rubygems.org'
+gemspec

data/lib/whowish_word/action_controller/base.rb

@@ -1,9 +1,9 @@
 if defined?(ActionController) and defined?(ActionController::Base)
   class ActionController::Base
     include WhowishWord::Constant
-    
+
     prepend_before_filter :initialize_whowish_word
-    helper_method :whowish_word
+    helper_method :whowish_word, :whowish_word_active?
     attr_accessor :whowish_word_config
 
     def initialize_whowish_word
@@ -14,48 +14,8 @@ if defined?(ActionController) and defined?(ActionController::Base)
       return @whowish_word_config
     end
 
-    # alias_method :previous_t, :t
-    # def t(uid, *variables)
-    #   if @whowish_word_config.edit_mode == true
-    #     s = PREFIX + \
-    #          SEPARATOR + \
-    #          scope_key_by_partial(uid.to_s) + \
-    #          SEPARATOR + \
-    #          previous_t(uid)
-    #     return "<dfn>#{s}</dfn>".html_safe
-    #   else
-    #     return previous_t(uid, *variables)
-    #   end
-    # end
-
-    # def ta(uid, *variables)
-    #   if @whowish_word_config.edit_mode == true
-    #     s = PREFIX + \
-    #          SEPARATOR + \
-    #          scope_key_by_partial(uid.to_s) + \
-    #          SEPARATOR + \
-    #          previous_t(uid)
-    #     return s.html_safe
-    #   else
-    #     return previous_t(uid, *variables)
-    #   end
-    # end
-
-    # def word_for(namespace, id, *variables)
-    #   if @whowish_word_config.edit_mode == true
-    #     return WhowishWord.word_for_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
-    #   else
-    #     return WhowishWord.word_for(namespace, id, @whowish_word_config.locale, *variables)
-    #   end
-    # end
-    
-    
-    # def word_for_attr(namespace, id, *variables)
-    #   if @whowish_word_config.edit_mode == true
-    #     return WhowishWord.word_for_attr_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
-    #   else
-    #     return WhowishWord.word_for_attr(namespace, id, @whowish_word_config.locale, *variables)
-    #   end
-    # end
+    def whowish_word_active?
+      @whowish_word_config.edit_mode == true
+    end
   end
-end
+end

data/lib/whowish_word/action_view/base.rb

@@ -3,8 +3,8 @@ if defined?(ActionView) and defined?(ActionView::Base)
     include WhowishWord::Constant
 
     def whowish_word_javascript_and_css(force = false)
-      return "" if @whowish_word_config.edit_mode != true and force == false
-      
+      return "" if !whowish_word_active? and force == false
+
       script_text = <<-HTML
         <script type="text/javascript">
           $w(function() {
@@ -12,59 +12,44 @@ if defined?(ActionView) and defined?(ActionView::Base)
           });
         </script>
       HTML
-      
+
       return javascript_include_tag("/whowish_word_js").sub('.js', '').html_safe + \
               stylesheet_link_tag("/whowish_word_css").sub('.css', '').html_safe + \
               script_text.html_safe
     end
 
-    # def global_word_for(namespace, id, *variables)
-    #   if @whowish_word_config.edit_mode == true
-    #     return WhowishWord.word_for_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
-    #   else
-    #     return WhowishWord.word_for(namespace, id, @whowish_word_config.locale, *variables)
-    #   end
-    # end
-
-
-    # def global_word_for_attr(namespace, id, *variables)
-    #   if @whowish_word_config.edit_mode == true
-    #     return WhowishWord.word_for_attr_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
-    #   else
-    #     return WhowishWord.word_for_attr(namespace, id, @whowish_word_config.locale, *variables)
-    #   end
-    # end
+    alias_method :previous_t, :t
 
-    # def word_for(id, *variables)
-    #   namespace = get_relative_view_path(@whowish_word_page)
-    #   global_word_for(namespace, id, *variables)
-    # end
+    # Translations that are plain-text and outside HTML attributes
+    def t(uid, *variables)
+      return previous_t(uid, *variables) unless whowish_word_active?
 
-    # def word_for_attr(id, *variables)
-    #   namespace = get_relative_view_path(@whowish_word_page)
-    #   global_word_for_attr(namespace, id, *variables)
-    # end
+      translation = previous_t uid
 
-    alias_method :previous_t, :t
-    def t(uid, *variables)
-      if @whowish_word_config.edit_mode == true
+      if translation.is_a?(String)
         s = PREFIX + \
              SEPARATOR + \
              scope_key_by_partial(uid.to_s) + \
              SEPARATOR + \
-             previous_t(uid)
+             translation
         return "<dfn>#{s}</dfn>".html_safe
       else
         return previous_t(uid, *variables)
       end
     end
 
+    # Translations that may contain HTML tags and are outside HTML attributes
     def th(uid, *variables)
       return t(uid, *variables).html_safe
     end
 
+    # Translations that are inside HTML attributes (must be plain-text by their definitions)
     def ta(uid, *variables)
-      if @whowish_word_config.edit_mode == true
+      return previous_t(uid, *variables) unless whowish_word_active?
+
+      translation = previous_t uid
+
+      if translation.is_a?(String)
         s = PREFIX + \
              SEPARATOR + \
              scope_key_by_partial(uid.to_s) + \
@@ -75,12 +60,5 @@ if defined?(ActionView) and defined?(ActionView::Base)
         return previous_t(uid, *variables)
       end
     end
-
-
-    # private
-    #   def get_relative_view_path(full_path)
-    #     result = @whowish_word_page.match(/[\/\\](([^\/\\]+)[\/\\]([^\/\\]+))\Z/)
-    #     return result[1]
-    #   end
   end
-end
+end

data/lib/whowish_word/backends/defer_to_i18n.rb

@@ -0,0 +1,18 @@
+module WhowishWord
+  module Backends
+    class DeferToI18n
+      def initialize
+      end
+
+      def set(key, value)
+        I18n.backend.store_translations(I18n.locale,
+                                        { key => value },
+                                        :escape => false)
+      end
+
+      def get(*args)
+        I18n.t *args
+      end
+    end
+  end
+end

data/lib/whowish_word/backends/flat_file_store.rb

@@ -0,0 +1,75 @@
+module WhowishWord
+  module Backends
+    class FlatFileStore
+      def set(key, value)
+        keys = key.split(".")
+        uid = keys.pop
+        filename = "#{I18n.locale}.yml"
+
+        if keys.length > 1
+          filename = "#{keys[1..-1].join("_")}_#{filename}"
+        end
+
+        paths = [ WhowishWord.config_file_dir ]
+        Rails.logger.debug WhowishWord.config_file_dir
+        paths.push(keys[0]) if keys.length > 0
+        paths.push(filename)
+
+        locale_file = File.join(*paths)
+        FileUtils.mkdir_p(File.join(*paths[0..-2]))
+
+        translation_keys = I18n.normalize_keys(I18n.locale, key, nil, ".")
+
+        file = nil
+        data = {}
+
+        begin
+          if !File.exists?(locale_file)
+            file = File.open(locale_file, 'w', 0777)
+            file.flock(File::LOCK_EX)
+          else
+            file = File.open(locale_file, 'r+', 0777)
+            file.flock(File::LOCK_EX)
+          end
+
+          begin
+            file.rewind
+            data = YAML.parse(file.read).to_ruby
+          rescue
+            data = {}
+          end
+
+          direct = data
+          translation_keys[0..-2].each { |k|
+            k = k.to_s
+            direct[k] ||= {}
+            direct = direct[k]
+          }
+
+          direct[translation_keys.last.to_s] = value
+
+          file.rewind
+          file.write(YAML.dump(data))
+          file.flush
+          file.truncate(file.pos)
+        ensure
+          file.flock(File::LOCK_UN)
+          file.close
+        end
+
+        direct = I18n.translations
+        translation_keys[0..-2].each { |k|
+          direct[k] ||= {}
+          direct = direct[k]
+        }
+        direct[translation_keys.last] = value
+
+        true
+      end
+
+      def get(*args)
+        I18n.t *args
+      end
+    end
+  end
+end

data/lib/whowish_word/constant.rb

@@ -1,9 +1,7 @@
 module WhowishWord
-  
   module Constant
     PREFIX = "__whowishWord__"
     SEPARATOR = "_____"
     ID_VARIABLES_SEPARATOR = "|"
   end
-  
-end
+end

data/lib/whowish_word/initializer.rb

@@ -1,54 +1,35 @@
 module WhowishWord
-
   module Initializer
-    
     def install_route
-      
       Rails.application.routes.prepend do
-        match "whowish_word/change_word", :to=>"whowish_word#change_word"
-        match "whowish_word_css", :to=>"whowish_word#css"
-        match "whowish_word_js", :to=>"whowish_word#js"
-        match "whowish_word/download", :to=>"whowish_word#download"
+        match "whowish_word/change_word", :to => "whowish_word#change_word"
+        match "whowish_word_css", :to => "whowish_word#css"
+        match "whowish_word_js", :to => "whowish_word#js"
+        match "whowish_word/download", :to => "whowish_word#download"
       end
-      
     end
     
-    # def run_database_migration
-      
-    #   Dir[File.expand_path("../db_migration/#{@orm_engine}/**/*.rb", __FILE__)].each {|f| require f}
-      
-    # end
-    
-      
-    
     def install_hook
-      
-      Dir[File.expand_path("../action_controller/**/*.rb", __FILE__)].each {|f| require f}
-      Dir[File.expand_path("../action_mailer/**/*.rb", __FILE__)].each {|f| require f}
-      Dir[File.expand_path("../action_view/**/*.rb", __FILE__)].each {|f| require f}
-      
+      require_all("../action_controller/**/*.rb")
+      require_all("../action_view/**/*.rb")
     end
     
-    
     def load_rails
-      
       paths = ["controllers"]
   
-      # load all controllers, helpers, and models
       paths.each do |dir|
-        
         path = File.join(File.dirname(__FILE__), 'rails', 'app', dir)
-        
         $LOAD_PATH.insert(0, path)
         ActiveSupport::Dependencies.autoload_paths.insert(0, path)
         ActiveSupport::Dependencies.autoload_once_paths.delete(path)
-        
       end
       
       ActionController::Base.append_view_path(File.join(File.dirname(__FILE__), 'rails', 'app'))
+    end
 
+    private
+    def require_all(path)
+      Dir[File.expand_path(path, __FILE__)].each { |f| require f }
     end
-    
   end
-
 end

data/lib/whowish_word/rails/app/controllers/whowish_word_controller.rb

@@ -1,118 +1,64 @@
-# encoding: utf-8
-
 class WhowishWordController < ApplicationController
+  before_filter do
+    if !whowish_word_active?
+      render :text => 'Not found', :status => 404
+    end
+  end
+
   def css
     text = ""
-    
-    Dir[File.expand_path("../../../public/stylesheets/*.css", __FILE__)].each { |f| 
+
+    Dir[File.expand_path("../../../public/stylesheets/*.css", __FILE__)].each { |f|
       text += IO.read(f)
       text += "\n\n"
     }
-    
+
     response.headers["Content-Type"] = "text/css; charset=utf-8"
     render :text=>text
   end
-  
+
   def js
     text = ""
-    
+
     all_files = Dir[File.expand_path("../../../public/javascripts/*.js", __FILE__)]
     all_files.sort! { |a, b| a <=> b}
-    
+
     all_files.each { |file|
       text += IO.read(file)
       text += "\n\n"
     }
-    
+
     response.headers["Content-Type"] = "text/javascript; charset=utf-8"
     render :text=>text
   end
-  
-  def change_word
 
-    keys = params[:word_id].split(".")
-    uid = keys.pop
-    filename = "#{I18n.locale}.yml"
+  def change_word
+    store = WhowishWord.backend.new
 
-    if keys.length > 1
-      filename = "#{keys[1..-1].join("_")}_#{filename}"
+    if store.set params[:word_id], params[:content]
+      render :json => { :ok => true }
+    else
+      render :json => { :ok => false }, :status => :unprocessable_entity
     end
+  end
 
-    paths = [ WhowishWord.config_file_dir ]
-    paths.push(keys[0]) if keys.length > 0
-    paths.push(filename)
-
-    locale_file = File.join(*paths)
-    FileUtils.mkdir_p(File.join(*paths[0..-2]))
+  def download
+    raise 'Not supported'
 
-    translation_keys = I18n.normalize_keys(I18n.locale, params[:word_id], nil, ".")
-    
-    file = nil
-    data = {}
-    
     begin
-      if !File.exists?(locale_file)
-        file = File.open(locale_file, 'w', 0777)
-        file.flock(File::LOCK_EX)
-      else
-        file = File.open(locale_file, 'r+', 0777)
-        file.flock(File::LOCK_EX)
-      end
-
-      begin
-        file.rewind
-        data = YAML.parse(file.read).to_ruby
-      rescue
-        data = {}
-      end
-
-      direct = data
-      translation_keys[0..-2].each { |k|
-        k = k.to_s
-        direct[k] ||= {}
-        direct = direct[k]
-      }
-
-      direct[translation_keys.last.to_s] = params[:content]
-
-      file.rewind
-      file.write(YAML.dump(data))
-      file.flush
-      file.truncate(file.pos)
-    ensure
-      file.flock(File::LOCK_UN)
-      file.close
+      require 'zip'
+    rescue Exception => e
+      raise 'Please install the rubyzip gem (version 1.1.0) in order to download whowish_word.zip through the web interface #{e}'
     end
 
-    direct = I18n.translations
-    translation_keys[0..-2].each { |k|
-      direct[k] ||= {}
-      direct = direct[k]
-    }
-    direct[translation_keys.last] = params[:content]
-
-    render :json=>{
-      :ok => true
-    }
-  end
-
-  def download
-    require 'zip/zip'
-    require 'zip/zipfilesystem'
-    
-    t = Tempfile.new("whowish_word.zip")
-    
-    Zip::ZipOutputStream.open(t.path) do |zos|
+    zipfile = Tempfile.new("whowish_word.zip")
+    Zip::File.open(zipfile.path, Zip::File::CREATE) do |zipfile|
       Dir["#{WhowishWord.config_file_dir}/**/*"].each do |file|
-        next if File.directory?(file)
-
-        zos.put_next_entry("#{file.sub(WhowishWord.config_file_dir + "/", "")}")
-        zos.print IO.read(file)
+        zipfile.add(file.sub(directory, ''), file)
       end
     end
 
-    send_file t.path, :filename => "whowish_word.zip", :content_type => "application/zip"
-
-    t.close
+    send_file zipfile.path, :filename => "whowish_word.zip", :content_type => "application/zip"
+    zipfile.close
   end
-end
+end