whowish_word 0.3.3 → 0.4.0

data/.gitignore

@@ -3,4 +3,6 @@
 spec/rails/tmp/*
 *.gem
 rails/db/*.sqlite3
-rails/tmp/*
+rails/tmp/*
+rails/.bundle/*
+.bundle/*

data/.project

@@ -12,7 +12,6 @@
 		</buildCommand>
 	</buildSpec>
 	<natures>
-		<nature>com.aptana.ruby.core.rubynature</nature>
 		<nature>org.rubypeople.rdt.core.rubynature</nature>
 	</natures>
 </projectDescription>

data/README.md

@@ -31,19 +31,19 @@ Demo: http://whowish-word.heroku.com
 How you should work
 -------------------
 
-In your view, e.g. index.html.erb, use word_for(:identifier) and word_for_attr(:identifier):
+In your view, e.g. index.html.erb, use t(:identifier) and ta(:identifier):
 
 ```erb
-<h1><%= word_for :title%></h1>
-<h3><%= word_for :you_are_here_for_number_of_times, :number=> 10 %></h3>
+<h1><%=t :title%></h1>
+<h3><%=t :you_are_here_for_number_of_times, :number=> 10 %></h3>
 
-<b><%= word_for :name_label%><b> <%= word_for :my_name%><br/>
+<b><%=t :name_label%><b> <%=t :my_name%><br/>
 
-<b><%= word_for :your_name_label%></b> 
-<input type="text" placeholder="<%= word_for_attr :your_name_here%>"><br/>
-<a href="#" title="<%= word_for_attr :your_name_will_be_kept_secret%>">?</a>
+<b><%=t :your_name_label%></b> 
+<input type="text" placeholder="<%=ta :your_name_here%>"><br/>
+<a href="#" title="<%=ta :your_name_will_be_kept_secret%>">?</a>
 
-<button><%= word_for_attr :submit_button%></button>
+<button><%=ta :submit_button%></button>
 ```
 
 Now when you want to edit wording:
@@ -71,13 +71,13 @@ Demo: http://whowish-word.heroku.com
 WhowishWord supports variables:
 
 ```erb
-<%= word_for :you_are_here_for_number_of_times, :number=> 10 %>
+<%=t :you_are_here_for_number_of_times, :number=> 10 %>
 ```
 
 If you set the word :you_are_here_for_number_of_times to be 
 
 ```
-You are here {number} times already
+You are here %{number} times already
 ```
 
 WhowishWord renders it as:
@@ -92,7 +92,7 @@ Multi-language support
 You can change locale of WhowishWord by:
 
 ```ruby
-whowish_word.set_locale("jp")
+I18n.locale = :en
 ```
 
 In Rails, you should add before_filter in the application controller as shown below:
@@ -106,7 +106,7 @@ def set_locale
   end
 
   session[:locale] ||= "en"
-  whowish_word.set_locale(session[:locale])
+  I18n.locale = session[:locale].to_sym
 end
 ```
 
@@ -114,7 +114,7 @@ end
 Prerequisite
 -------------------
 
-Rails 3.1.*
+Rails 3.2.3
 
 It does not work with Rails 3.0.*, yet. Please send me an issue and I will fix it. (I'm just lazy)
 
@@ -123,7 +123,7 @@ It does not work with Rails 3.0.*, yet. Please send me an issue and I will fix i
 How to use it
 -------------------
 
-First, install it:
+1. Install it:
 ```
 gem install whowish_word
 ```
@@ -133,17 +133,15 @@ Or, in your Gemfile, put in the below line:
 gem 'whowish_word'
 ```
 
-Second, create RAILS_ROOT/config/initializers/whowish_word.rb that contains:
+2. Create ```RAILS_ROOT/config/initializers/whowish_word.rb``` that contains:
 
 ```ruby
 require 'whowish_word'
 
-WhowishWord.init(:active_record)
+WhowishWord.init()
 
 ```
 
-You can use either use :active_record or :mongoid
-
 And, in your layout, please drop this line inside the tag header:
 
 ```erb
@@ -152,11 +150,12 @@ And, in your layout, please drop this line inside the tag header:
 
 It is to include the required Javascript and css files, when the edit mode is activated.
 
+3. When deploying, please create a folder ```RAILS_ROOT/config/locales/whowish_word``` and make it a shared path.
 
-Performance
--------------------
+All edited words will be generated in this folder.
+
+Please also make the folder writable.
 
-It is fast because words are kept in memory. They are not kept in database while your Rails is running.
 
 
 Help me
@@ -164,10 +163,6 @@ Help me
 
 1. Fork the project
 	* Run all tests first:
-		* Go to ROOT, type 
-		```
-			bundle exec rspec spec/*
-		```
 		* Go to ROOT/rails, type
 		```
 			bundle exec rspec spec/*
@@ -184,7 +179,6 @@ Authors
 -------------------
 
 Tanin Na Nakorn
-
 Tanun Niyomjit (Designer)
 
 

data/lib/whowish_word/action_controller/base.rb

@@ -1,46 +1,32 @@
-
 if defined?(ActionController) and defined?(ActionController::Base)
-
   class ActionController::Base
-    
     prepend_before_filter :initialize_whowish_word
+    helper_method :whowish_word
     attr_accessor :whowish_word_config
 
-
     def initialize_whowish_word
       @whowish_word_config = WhowishWord::Config.new
-      $whowish_word_config = @whowish_word_config
     end
 
-
-    helper_method :whowish_word
-    
     def whowish_word
       return @whowish_word_config
     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(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 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
   end
-
 end

data/lib/whowish_word/action_mailer/base.rb

@@ -1,12 +1,7 @@
-
 if defined?(ActionMailer) and defined?(ActionMailer::Base)
-
   class ActionMailer::Base
-    
-    def word_for(id, *p)
-      WhowishWord.word_for(mailer_name + "/" + @template+".html.erb",id,*p)
-    end
-    
+    # def word_for(id, *p)
+    #   WhowishWord.word_for(mailer_name + "/" + @template+".html.erb",id,*p)
+    # end
   end
-
 end

data/lib/whowish_word/action_view/base.rb

@@ -1,11 +1,8 @@
-
 if defined?(ActionView) and defined?(ActionView::Base)
-
   class ActionView::Base
-
+    include WhowishWord::Constant
 
     def whowish_word_javascript_and_css(force = false)
-      
       return "" if @whowish_word_config.edit_mode != true and force == false
       
       script_text = <<-HTML
@@ -16,56 +13,70 @@ if defined?(ActionView) and defined?(ActionView::Base)
         </script>
       HTML
       
-      return "<script src='/whowish_word_js?#{Time.now.to_i}' type='text/javascript'></script>".html_safe + \
-             "<link href='/whowish_word_css?#{Time.now.to_i}' rel='stylesheet' type='text/css' />".html_safe + \
+      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)
-      
+    # 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
+
+    # def word_for(id, *variables)
+    #   namespace = get_relative_view_path(@whowish_word_page)
+    #   global_word_for(namespace, id, *variables)
+    # end
+
+    # def word_for_attr(id, *variables)
+    #   namespace = get_relative_view_path(@whowish_word_page)
+    #   global_word_for_attr(namespace, id, *variables)
+    # end
+
+    alias_method :previous_t, :t
+    def t(uid, *variables)
       if @whowish_word_config.edit_mode == true
-        return WhowishWord.word_for_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
+        s = PREFIX + \
+             SEPARATOR + \
+             uid.to_s + \
+             SEPARATOR + \
+             previous_t(uid, *variables)
+        return "<dfn>#{s}</dfn>".html_safe
       else
-        return WhowishWord.word_for(namespace, id, @whowish_word_config.locale, *variables)
+        return previous_t(uid, *variables)
       end
-      
     end
 
-
-    def global_word_for_attr(namespace, id, *variables)
-      
+    def ta(uid, *variables)
       if @whowish_word_config.edit_mode == true
-        return WhowishWord.word_for_attr_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
+        s = PREFIX + \
+             SEPARATOR + \
+             uid.to_s + \
+             SEPARATOR + \
+             previous_t(uid, *variables)
+        return s.html_safe
       else
-        return WhowishWord.word_for_attr(namespace, id, @whowish_word_config.locale, *variables)
+        return previous_t(uid, *variables)
       end
-      
     end
 
 
-    def word_for(id, *variables)
-      
-      namespace = get_relative_view_path(@whowish_word_page)
-      global_word_for(namespace, id, *variables)
-      
-    end
-
-
-    def word_for_attr(id, *variables)
-      
-      namespace = get_relative_view_path(@whowish_word_page)
-      global_word_for_attr(namespace, id, *variables)
-      
-    end
-
-
-    private
-      def get_relative_view_path(full_path)
-        result = @whowish_word_page.match(/[\/\\](([^\/\\]+)[\/\\]([^\/\\]+))\Z/)
-        return result[1]
-    end
-
+    # private
+    #   def get_relative_view_path(full_path)
+    #     result = @whowish_word_page.match(/[\/\\](([^\/\\]+)[\/\\]([^\/\\]+))\Z/)
+    #     return result[1]
+    #   end
   end
-
 end

data/lib/whowish_word/action_view/template.rb

@@ -1,31 +1,31 @@
 
-if defined?(ActionView) and defined?(ActionView::Base)
+# if defined?(ActionView) and defined?(ActionView::Base)
   
-  class ActionView::Template
+#   class ActionView::Template
     
-    alias_method :render_original, :render
+#     alias_method :render_original, :render
     
-    def render(view, locals, buffer=nil, &block)
+#     def render(view, locals, buffer=nil, &block)
 
-      previous_whowish_word_page = nil
+#       previous_whowish_word_page = nil
       
-      if view.instance_variable_defined?(:@whowish_word_page)
-        previous_whowish_word_page = view.instance_variable_get(:@whowish_word_page)
-      end
+#       if view.instance_variable_defined?(:@whowish_word_page)
+#         previous_whowish_word_page = view.instance_variable_get(:@whowish_word_page)
+#       end
     
-      view.instance_variable_set(:@whowish_word_page, @identifier)
+#       view.instance_variable_set(:@whowish_word_page, @identifier)
       
-      if view.controller.respond_to?(:whowish_word_edit_mode)
-        view.instance_variable_set(:@whowish_word_edit_mode, view.controller.whowish_word_edit_mode)
-      end
+#       if view.controller.respond_to?(:whowish_word_edit_mode)
+#         view.instance_variable_set(:@whowish_word_edit_mode, view.controller.whowish_word_edit_mode)
+#       end
       
-      html = render_original(view, locals, buffer, &block)
+#       html = render_original(view, locals, buffer, &block)
       
-      view.instance_variable_set(:@whowish_word_page, previous_whowish_word_page)
+#       view.instance_variable_set(:@whowish_word_page, previous_whowish_word_page)
 
-      return html
-    end
+#       return html
+#     end
   
-  end
+#   end
   
-end
+# end

data/lib/whowish_word/authentication.rb

@@ -1,14 +1,14 @@
-module WhowishWord
+# module WhowishWord
 
-  module Authentication
+#   module Authentication
    
-    attr_accessor :username, :password
+#     attr_accessor :username, :password
     
-    def init_username_and_password
-      @username ||= "whowishword"
-      @password ||= "pass"
-    end
+#     def init_username_and_password
+#       @username ||= "whowishword"
+#       @password ||= "pass"
+#     end
     
-  end
+#   end
   
-end
+# end

data/lib/whowish_word/config.rb

@@ -1,22 +1,13 @@
 module WhowishWord
-  
   class Config
-    
-    attr_accessor :locale, :edit_mode
+    attr_accessor :edit_mode
     
     def initialize
-      @locale = "en"
       @edit_mode = false
     end
     
     def activate_edit_mode
       @edit_mode = true
     end
-    
-    def set_locale(locale)
-      @locale = locale
-    end
-    
   end
-  
 end

data/lib/whowish_word/db_migration/active_record/whowish_word_html.rb

@@ -1,15 +1,15 @@
-begin 
-  ActiveRecord::Schema.define do
+# begin 
+#   ActiveRecord::Schema.define do
   
-    create_table "whowish_word_htmls", :force => false do |t|
-      t.string "word_id", :null => false
-      t.text  "content", :null => false
-    end
+#     create_table "whowish_word_htmls", :force => false do |t|
+#       t.string "word_id", :null => false
+#       t.text  "content", :null => false
+#     end
     
-    add_index :whowish_word_htmls, :word_id, :unique => true
+#     add_index :whowish_word_htmls, :word_id, :unique => true
     
-  end
+#   end
 
-rescue Exception=>e
+# rescue Exception=>e
 
-end
+# end

data/lib/whowish_word/db_migration/mongoid/whowish_word_html.rb

@@ -1,6 +1,6 @@
-begin 
-  WhowishWordHtml.collection.drop_indexes
-  WhowishWordHtml.create_indexes
-rescue Exception=>e
+# begin 
+#   WhowishWordHtml.collection.drop_indexes
+#   WhowishWordHtml.create_indexes
+# rescue Exception=>e
 
-end
+# end

data/lib/whowish_word/initializer.rb

@@ -12,11 +12,11 @@ module WhowishWord
       
     end
     
-    def run_database_migration
+    # def run_database_migration
       
-      Dir[File.expand_path("../db_migration/#{@orm_engine}/**/*.rb", __FILE__)].each {|f| require f}
+    #   Dir[File.expand_path("../db_migration/#{@orm_engine}/**/*.rb", __FILE__)].each {|f| require f}
       
-    end
+    # end
     
       
     
@@ -31,7 +31,7 @@ module WhowishWord
     
     def load_rails
       
-      paths = ["controllers","models/#{@orm_engine}"]
+      paths = ["controllers"]
   
       # load all controllers, helpers, and models
       paths.each do |dir|

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

@@ -1,7 +1,5 @@
-class WhowishWordController < ActionController::Base
-  
+class WhowishWordController < ApplicationController
   def css
-    
     text = ""
     
     Dir[File.expand_path("../../../public/stylesheets/*.css", __FILE__)].each { |f| 
@@ -11,11 +9,9 @@ class WhowishWordController < ActionController::Base
     
     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__)]
@@ -28,34 +24,47 @@ class WhowishWordController < ActionController::Base
     
     response.headers["Content-Type"] = "text/javascript; charset=utf-8"
     render :text=>text
-    
   end
   
   def change_word
+    locale_file = File.join(Rails.root, "config", "locales", "whowish_word", "#{I18n.locale}.yml")
+    
+    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
 
-    entity = WhowishWordHtml.first(:conditions=>{:word_id => params[:word_id].strip})
+      begin
+        file.rewind
+        data = YAML.parse(file.read).to_ruby
+      rescue
+        data = {}
+      end
 
-    entity = WhowishWordHtml.new if !entity
+      data[I18n.locale.to_s] ||= {}
+      data[I18n.locale.to_s][params[:word_id]] = params[:content]
 
-    entity.word_id = params[:word_id].strip
-    entity.content = params[:content].strip
-    
-    if !entity.save
-      
-      error_message = "WhowishWord fails to change the word you specified.<br/>" + \
-                      "Possible causes:<br/>" + \
-                      "- Someone else changed the word at the very same time<br/>" + \
-                      "- Database connection failed<br/>" + \
-                      "By all means, please try again.<br/>"
-                      
-      render :json=>{:ok=>false,:error_message=>error_message}
-      
+      file.rewind
+      file.write(YAML.dump(data))
+      file.flush
+      file.truncate(file.pos)
+    ensure
+      file.flock(File::LOCK_UN)
+      file.close
     end
+
+    I18n.translations[I18n.locale.to_sym] ||= {}
+    I18n.translations[I18n.locale.to_sym][params[:word_id].to_sym] = params[:content]
     
-    WhowishWord.add_or_set_word(entity.word_id, entity.content)
-    
-    render :json=>{:ok=>true}
+    render :json=>{
+      :ok => true
+    }
   end
-  
-  
 end

data/lib/whowish_word/rails/app/models/active_record/whowish_word_html.rb

@@ -1,4 +1,4 @@
-class WhowishWordHtml < ActiveRecord::Base
+# class WhowishWordHtml < ActiveRecord::Base
   
   
-end
+# end

data/lib/whowish_word/rails/app/models/mongoid/whowish_word_html.rb

@@ -1,9 +1,9 @@
-class WhowishWordHtml
-  include Mongoid::Document
+# class WhowishWordHtml
+#   include Mongoid::Document
   
-  field :word_id,:type=>String
-  field :content, :type=>String
+#   field :word_id,:type=>String
+#   field :content, :type=>String
   
-  index [[ :word_id, Mongo::DESCENDING ]], :unique=>true
+#   index [[ :word_id, Mongo::DESCENDING ]], :unique=>true
   
-end
+# end

data/lib/whowish_word/whowish_word.rb

@@ -8,32 +8,31 @@ module WhowishWord
   include WhowishWord::Constant
   include WhowishWord::Initializer
   include WhowishWord::WordFor
-  include WhowishWord::Authentication
+  # include WhowishWord::Authentication
   
   attr_accessor :words
   
-  def init(orm_engine = :active_record)
-    
-    @orm_engine = orm_engine
-    
-    init_username_and_password
+  def init()
     install_route
     install_hook
     load_rails
     
-    run_database_migration
-    
-    words = WhowishWordHtml.all()
-      
-    @words = {}
-    words.each { |word|
-      @words[word.word_id] = word.content
-    }
-    
-  end
+    Rails.configuration.i18n.load_path += Dir[Rails.root.join('config', 'locales', 'whowish_word', '**', '*.{rb,yml}')]
   
-  def add_or_set_word(word_id, content)
-    @words[word_id] = content
+    I18n.class_eval do
+      class << self
+        def translations
+          backend.send(:translations)
+        end
+      end
+    end
+
+    I18n::MissingTranslation::Base.class_eval do
+      def html_message
+        key = keys.last.to_s.gsub('_', ' ').gsub(/\b('?[a-z])/) { $1.capitalize }
+        key
+      end
+    end
   end
 
   extend self