e9s 2.0.1 → 2.1.1

data/CHANGELOG

@@ -1,5 +1,15 @@
 = E9s CHANGELOG
 
+== Version 2.1.1 (October 1, 2010)
+
+* Added rails generator 'enrichments'
+* Updated gem dependencies
+
+== Version 2.1.0 (August 15, 2010)
+
+* Added Rich-CMS (yay!)
+* Being to translate in the frontend
+
 == Version 2.0.1 (July 22, 2010)
 
 * Fixed requiring modules on initialization

data/README.textile

@@ -1,19 +1,26 @@
 
 h1. E9s
 
-Enrichments (e9s) for internationalization (i18n) and localized pluralization
+Enrichments (e9s) for pluggable a CMS, internationalization (i18n) and localized pluralization
 
 h2. Introduction
 
-E9s was created due to the need of simply implementing I18n within a Rails application. This simplifies internationalization of your Rails application making a Rails developers life much easier. E9s is divided into modules (as gem and plugin): "Rich-i18n":http://github.com/archan937/rich_i18n and "Rich-pluralization":http://github.com/archan937/rich_pluralization. A list of E9s' features:
+E9s was created due to the need of simply implementing I18n within a Rails application. This simplifies internationalization of your Rails application making a Rails developers life much easier. E9s is divided into modules (as gem and plugin): "Rich-CMS":http://github.com/archan937/rich_cms , "Rich-i18n":http://github.com/archan937/rich_i18n and "Rich-pluralization":http://github.com/archan937/rich_pluralization. A list of E9s' features:
+
+h3. Pluggable CMS
+
+* @Easy setup@ - Rich-CMS only has a two-liner setup
+* @Authentication@ - Easily specify the authentication logic to be used
+* @Add editable content@ - Easily specify content available within the CMS by registering them
 
 h3. I18n
 
+* @Translate on-site@ - Just specify you want to use Rich-CMS and you are set to translate in the front-end
 * @Localized pluralization@ - Translations only in singular form are sufficient enough as E9s can pluralize in foreign languages
 * @Default values@ - Use the translation key (or a portion) as default value: @"continue".t@ returns @"continue"@ and @"text.Welcome_to_our_site".t@ returns @"Welcome to our site"@
 * @An easy interface@ - Just call the @t@ method on string or symbols to translate and @pl@ to pluralize
 * @Combine translations@ - Joining keys with spaces combines translations: @"More houses".t@ returns @"Meer huizen"@ in Dutch
-* @Preserve i18n meta data@ - E9s preserves the key, the actual used I18n key and the actual translation which you can enquire (this can come in handy when implementing a CMS)
+* @Preserve i18n meta data@ - Rich-i18n preserves the translation @key@, @value@, @locale@ and @derivative key@ (the argument passed for translation). Enquiring this can come in handy when implementing an internationalization CMS (see "Rich-CMS":http://github.com/archan937/rich_cms).
 
 h3. Formtastic
 
@@ -40,16 +47,6 @@ Add e9s in environment.rb as a gem dependency:
   config.gem "e9s"
 </pre>
 
-h3. Optional
-
-When wanting to use @seatholders@, please include @seat_holder.js@ in your template:
-
-<pre>
-  <script src="path/to/seat_holder.js" type="text/javascript"></script>
-</pre>
-
-*Note*: please visit "http://github.com/archan937/seat_holder":http://github.com/archan937/seat_holder for more information about SeatHolder.
-
 h3. Testing E9s out-of-the-box
 
 Set the default locale to @:nl@ in @environment.rb@:
@@ -183,13 +180,13 @@ You can combine translations by using passed string containing translation keys
 
 h3. Translation meta data with EnrichedString
 
-When translating text, you possibly want to know the @used key@, the @actual used I18n key@ and its @actual translation@. E9s preserves just that in an @EnrichedString@ which is a subclass of @String@. Calling @.meta_data@ returns a hash with the meta data:
+When translating text, you possibly want to know the @key@, the @value@, the @locale@ and the @derivative key@ (the argument passed for translation). Rich-i18n preserves just that in an @EnrichedString@ which is a subclass of @String@. Calling @.meta_data@ returns a hash with the meta data:
 
 <pre>
   >> "MORE".t.class
   => Rich::I18n::Core::EnrichedString
   >> "MORE".t.meta_data
-  => {:actual_key=>"word.more", :key=>"MORE", :actual_value=>"MEER"}
+  => {:locale=>:nl, :value=>"meer", :derivative_key=>"MORE", :key=>"word.more"}
 </pre>
 
 Keep in mind that combined translations are possible and fortunately EnrichedString is able to cope with that. A concatenated translation has @merged_strings@ which contains every segments:
@@ -198,13 +195,13 @@ Keep in mind that combined translations are possible and fortunately EnrichedStr
   >> "More users".t
   => "Meer gebruikers"
   >> "More users".t.merged_strings
-  => ["Meer", "gebruikers"]
+  => ["Meer", " ", "gebruikers"]
   >> "More users".t.meta_data
   => nil
   >> "More users".t.merged_strings.first.meta_data
-  => {:actual_key=>"word.more", :key=>"More", :actual_value=>"Meer"}
+  => {:locale=>:nl, :value=>"meer", :derivative_key=>"More", :key=>"word.more"}
   >> "More users".t.merged_strings.last.meta_data
-  => {:actual_key=>"word.user", :key=>"users", :actual_value=>"gebruiker"}
+  => {:locale=>:nl, :value=>"gebruiker", :derivative_key=>"users", :key=>"word.user"}
   >> "One".t + " " + "question".t
   => "één vraag"
   >> ("One".t + " " + "question".t).merged_strings
@@ -216,8 +213,10 @@ h3. String.to_output
 E9s adds the @to_output@ method to the String class. This returns the an @i18n tag@ with @HTML 5 attributes@ in which the translation meta data is provided:
 
 <pre>
+  >> E9s::Engine.enable_enriched_output = true
+  => true
   >> "More users".t.to_output
-  => "<i18n data-actual_key=\"word.more\" data-key=\"More\" data-actual_value=\"Meer\">Meer</i18n><i18n data-actual_key=\"word.user\" data-key=\"users\" data-actual_value=\"gebruiker\">gebruikers</i18n>"
+  => "<i18n data-value=\"meer\" data-locale=\"nl\" data-key=\"word.more\" data-derivative_key=\"More\">Meer</i18n> <i18n data-value=\"gebruiker\" data-locale=\"nl\" data-key=\"word.user\" data-derivative_key=\"users\">gebruikers</i18n>"
 </pre>
 
 This can be very handy when implementing a CMS in which users change translations. Please note that "http://github.com/archan937/e9s-demo":http://github.com/archan937/e9s-demo uses this feature to highlight translations. Later on this will also be used in "Rich-CMS":http://github.com/archan937/rich_cms, a gem / plugin that makes inplace translating possible (please be patient for this to be released).
@@ -290,23 +289,36 @@ For support, remarks and requests please mail me at "paul.engel@holder.nl":mailt
 
 h2. Credit
 
-This Rails gem depends on:
+This Rails gem / plugin depends on:
 
-rich_pluralization<br>
-"http://github.com/archan937/rich_pluralization":http://github.com/archan937/rich_pluralization
+Rich-CMS<br>
+"http://github.com/archan937/rich_cms":http://github.com/archan937/rich_cms
 
-rich_i18n<br>
+Rich-i18n<br>
 "http://github.com/archan937/rich_i18n":http://github.com/archan937/rich_i18n
 
+Rich-pluralization<br>
+"http://github.com/archan937/rich_pluralization":http://github.com/archan937/rich_pluralization
+
 i18n<br>
 "http://github.com/svenfuchs/i18n":http://github.com/svenfuchs/i18n
 
-Formtastic (optional)<br>
+Formtastic<br>
 "http://github.com/justinfrench/formtastic":http://github.com/justinfrench/formtastic
 
-SeatHolder (optional)<br>
+SeatHolder<br>
 "http://github.com/archan937/seat_holder":http://github.com/archan937/seat_holder
 
+h2. E9s
+
+E9s - "http://github.com/archan937/e9s":http://github.com/archan937/e9s
+
+h3. E9s modules
+
+* Rich-CMS - "http://github.com/archan937/rich_cms":http://github.com/archan937/rich_cms
+* Rich-i18n - "http://github.com/archan937/rich_i18n":http://github.com/archan937/rich_i18n
+* Rich-pluralization - "http://github.com/archan937/rich_pluralization":http://github.com/archan937/rich_pluralization
+
 h2. License
 
 Copyright (c) 2010 Paul Engel, released under the MIT license

data/Rakefile

@@ -6,14 +6,15 @@ begin
   require "jeweler"
   Jeweler::Tasks.new do |gemspec|
     gemspec.name        = "e9s"
-    gemspec.summary     = "Enrichments (e9s) for internationalization (i18n) and localized pluralization"
-    gemspec.description = "E9s was created due to the need of simply implementing I18n within a Rails application. This simplifies internationalization of your Rails application making a Rails developers life much easier. E9s is divided into modules (as gem and plugin): Rich-i18n (http://github.com/archan937/rich_i18n) and Rich-pluralization (http://github.com/archan937/rich_pluralization)."
+    gemspec.summary     = "Enrichments (e9s) for a pluggable CMS, internationalization (i18n) and localized pluralization"
+    gemspec.description = "E9s was created due to the need of simply implementing I18n within a Rails application. This simplifies internationalization of your Rails application making a Rails developers life much easier. E9s is divided into modules (as gem and plugin): Rich-CMS (http://github.com/archan937/rich_cms) , Rich-i18n (http://github.com/archan937/rich_i18n) and Rich-pluralization (http://github.com/archan937/rich_pluralization)."
     gemspec.email       = "paul.engel@holder.nl"
     gemspec.homepage    = "http://github.com/archan937/e9s"
     gemspec.author      = "Paul Engel"
 
-    gemspec.add_dependency "rich_i18n"
-    gemspec.add_dependency "rich_pluralization"
+    gemspec.add_dependency "rich_cms"          , ">= 2.0.4"
+    gemspec.add_dependency "rich_i18n"         , ">= 1.2.0"
+    gemspec.add_dependency "rich_pluralization", ">= 1.0.3"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-2.0.1
+2.1.1

data/e9s.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{e9s}
-  s.version = "2.0.1"
+  s.version = "2.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Engel"]
-  s.date = %q{2010-07-22}
-  s.description = %q{E9s was created due to the need of simply implementing I18n within a Rails application. This simplifies internationalization of your Rails application making a Rails developers life much easier. E9s is divided into modules (as gem and plugin): Rich-i18n (http://github.com/archan937/rich_i18n) and Rich-pluralization (http://github.com/archan937/rich_pluralization).}
+  s.date = %q{2010-10-01}
+  s.description = %q{E9s was created due to the need of simply implementing I18n within a Rails application. This simplifies internationalization of your Rails application making a Rails developers life much easier. E9s is divided into modules (as gem and plugin): Rich-CMS (http://github.com/archan937/rich_cms) , Rich-i18n (http://github.com/archan937/rich_i18n) and Rich-pluralization (http://github.com/archan937/rich_pluralization).}
   s.email = %q{paul.engel@holder.nl}
   s.extra_rdoc_files = [
     "README.textile"
@@ -26,8 +26,11 @@ Gem::Specification.new do |s|
      "init.rb",
      "install.rb",
      "lib/e9s.rb",
+     "lib/e9s/actionpack.rb",
+     "lib/e9s/actionpack/action_view/base.rb",
      "lib/e9s/engine.rb",
      "rails/init.rb",
+     "rails_generators/enrichments/enrichments_generator.rb",
      "tasks/e9s_tasks.rake",
      "test/e9s_test.rb",
      "test/test_helper.rb",
@@ -37,7 +40,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Enrichments (e9s) for internationalization (i18n) and localized pluralization}
+  s.summary = %q{Enrichments (e9s) for a pluggable CMS, internationalization (i18n) and localized pluralization}
   s.test_files = [
     "test/e9s_test.rb",
      "test/test_helper.rb"
@@ -48,15 +51,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rich_i18n>, [">= 0"])
-      s.add_runtime_dependency(%q<rich_pluralization>, [">= 0"])
+      s.add_runtime_dependency(%q<rich_cms>, [">= 2.0.4"])
+      s.add_runtime_dependency(%q<rich_i18n>, [">= 1.2.0"])
+      s.add_runtime_dependency(%q<rich_pluralization>, [">= 1.0.3"])
     else
-      s.add_dependency(%q<rich_i18n>, [">= 0"])
-      s.add_dependency(%q<rich_pluralization>, [">= 0"])
+      s.add_dependency(%q<rich_cms>, [">= 2.0.4"])
+      s.add_dependency(%q<rich_i18n>, [">= 1.2.0"])
+      s.add_dependency(%q<rich_pluralization>, [">= 1.0.3"])
     end
   else
-    s.add_dependency(%q<rich_i18n>, [">= 0"])
-    s.add_dependency(%q<rich_pluralization>, [">= 0"])
+    s.add_dependency(%q<rich_cms>, [">= 2.0.4"])
+    s.add_dependency(%q<rich_i18n>, [">= 1.2.0"])
+    s.add_dependency(%q<rich_pluralization>, [">= 1.0.3"])
   end
 end
 

data/lib/e9s.rb

@@ -1,8 +1,10 @@
 
+require "e9s/actionpack"
+
 module E9s
   extend self
   
-  MODULES = %w(i18n pluralization)
+  MODULES = %w(cms i18n pluralization)
   
   def require_modules
     MODULES.each do |mod|

data/lib/e9s/actionpack.rb

@@ -0,0 +1,2 @@
+
+require File.join(File.dirname(__FILE__), "actionpack", "action_view", "base.rb")

data/lib/e9s/actionpack/action_view/base.rb

@@ -0,0 +1,19 @@
+
+module ActionView
+  class Base
+
+    def e9s
+      ::E9s::MODULES.collect do |mod|
+        if respond_to?(method = "rich_#{mod}")
+          send(method)
+        end
+      end.compact.join("\n")
+    end
+    
+    def link(name, options = nil)
+      options = {:class => options || name.underscore} unless options.is_a?(Hash)
+      link_to name, "#", options
+    end
+
+  end
+end

data/rails_generators/enrichments/enrichments_generator.rb

@@ -0,0 +1,62 @@
+class EnrichmentsGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @user        = options[:user]
+    @content     = options[:content]
+    @translation = options[:translation]
+  end
+
+  def manifest
+    record do |m|
+      # do something
+    end
+  end
+  
+  def after_generate
+    system "script/generate rich_authlogic_user   #{options[:user]       }" unless options[:user]        && options[:user]       .empty?
+    system "script/generate rich_cms_content      #{options[:content]    }" unless options[:content]     && options[:content]    .empty?
+    system "script/generate rich_i18n_translation #{options[:translation]}" unless options[:translation] && options[:translation].empty?
+    
+    system "rake db:migrate" if options[:migrate]
+  end
+
+  def model_file_name
+    @name.underscore
+  end
+
+  def model_class_name
+    @name.classify
+  end
+  
+  def table_name
+    model_file_name.gsub("/", "_").pluralize
+  end
+
+  def migration_file_name
+    "create_#{table_name}"
+  end
+
+  def migration_class_name
+    migration_file_name.camelize
+  end
+
+protected
+
+  def add_options!(opt)
+    opt.separator ""
+    opt.separator "Options:"
+    opt.on("-u", "--user"       , "The name of the Authlogic user model which is User at default."         ) { |v| options[:user]        = v == true ? "" : v }
+    opt.on("-c", "--content"    , "The name of the CMS content model which is CmsContent at default."      ) { |v| options[:content]     = v == true ? "" : v }
+    opt.on("-t", "--translation", "The name of the I18n translation model which is Translation at default.") { |v| options[:translation] = v == true ? "" : v }
+    opt.on("-m", "--migrate"    , "Run 'rake db:migrate' after generating model and migration."            ) {     options[:migrate]     =      true          }
+  end
+  
+  def banner
+    <<-EOS
+Creates entities used by Enrichments (e9s).
+
+USAGE: #{$0} #{spec.name}
+EOS
+  end
+
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: e9s
 version: !ruby/object:Gem::Version 
+  hash: 9
   prerelease: false
   segments: 
   - 2
-  - 0
   - 1
-  version: 2.0.1
+  - 1
+  version: 2.1.1
 platform: ruby
 authors: 
 - Paul Engel
@@ -14,36 +15,58 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-22 00:00:00 +02:00
+date: 2010-10-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rich_i18n
+  name: rich_cms
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
+        - 2
         - 0
-        version: "0"
+        - 4
+        version: 2.0.4
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rich_pluralization
+  name: rich_i18n
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
+        - 1
+        - 2
         - 0
-        version: "0"
+        version: 1.2.0
   type: :runtime
   version_requirements: *id002
-description: "E9s was created due to the need of simply implementing I18n within a Rails application. This simplifies internationalization of your Rails application making a Rails developers life much easier. E9s is divided into modules (as gem and plugin): Rich-i18n (http://github.com/archan937/rich_i18n) and Rich-pluralization (http://github.com/archan937/rich_pluralization)."
+- !ruby/object:Gem::Dependency 
+  name: rich_pluralization
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id003
+description: "E9s was created due to the need of simply implementing I18n within a Rails application. This simplifies internationalization of your Rails application making a Rails developers life much easier. E9s is divided into modules (as gem and plugin): Rich-CMS (http://github.com/archan937/rich_cms) , Rich-i18n (http://github.com/archan937/rich_i18n) and Rich-pluralization (http://github.com/archan937/rich_pluralization)."
 email: paul.engel@holder.nl
 executables: []
 
@@ -62,8 +85,11 @@ files:
 - init.rb
 - install.rb
 - lib/e9s.rb
+- lib/e9s/actionpack.rb
+- lib/e9s/actionpack/action_view/base.rb
 - lib/e9s/engine.rb
 - rails/init.rb
+- rails_generators/enrichments/enrichments_generator.rb
 - tasks/e9s_tasks.rake
 - test/e9s_test.rb
 - test/test_helper.rb
@@ -82,6 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -90,6 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -99,7 +127,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Enrichments (e9s) for internationalization (i18n) and localized pluralization
+summary: Enrichments (e9s) for a pluggable CMS, internationalization (i18n) and localized pluralization
 test_files: 
 - test/e9s_test.rb
 - test/test_helper.rb