e9s 2.1.4 → 2.2.0

data/CHANGELOG

@@ -1,5 +1,12 @@
 = E9s CHANGELOG
 
+== Version 2.2.0 (November 8, 2010)
+
+* Made E9s Rails 2 and 3 compatible (woot!)
+* Using Rich-CMS v2.1.1 and higher
+* Using Rich-i18n v1.3.1 and higher
+* Using Rich-pluralization v1.0.6 and higher
+
 == Version 2.1.4 (October 20, 2010)
 
 * Using Rich-CMS v2.0.7 and higher

data/README.textile

@@ -35,33 +35,44 @@ h3. Inflections
 
 h2. Installation
 
-Install the E9s gem:
+h3. Using E9s as gem in Rails 3
+
+Add E9s in @Gemfile@ as a gem dependency:
+
+<pre>
+  gem "e9s"
+</pre>
+
+Run the following in your console to install with Bundler:
 
 <pre>
-  sudo gem install e9s
+  bundle install
 </pre>
 
-Add e9s in environment.rb as a gem dependency:
+h3. Using E9s as gem in Rails 2
+
+Add E9s in @environment.rb@ as a gem dependency:
 
 <pre>
   config.gem "e9s"
 </pre>
 
-h3. Testing E9s out-of-the-box
+Run the following in your console:
 
-Run the Rails console:
+<pre>
+  sudo rake gems:install
+</pre>
+
+h3. Using E9s as plugin in Rails 3
 
 <pre>
-  ./script/console
+  rails plugin install git://github.com/archan937/e9s.git
 </pre>
 
-Start translating in Dutch:
+h3. Using E9s as plugin in Rails 2
 
 <pre>
-  >> I18n.locale = :nl
-  => :nl
-  >> "MORE HOUSES".t
-  => "MEER HUIZEN"
+  script/plugin install git://github.com/archan937/e9s.git
 </pre>
 
 h2. Use the provided Rails generator
@@ -74,18 +85,26 @@ In order to manage translations and/or CMS content. You need the following entit
 
 Fortunately, E9s is provided with a Rails generator with which you can generate all the entities.
 
-h3. In your console
+h4. In Rails 3
 
-Run the following command:
+Run the following in your console:
 
 <pre>
-  script/generate enrichments
+  rails g enrichments -m
 </pre>
 
 *Note*: The generator has the @-m@ or @--migrate@ option which runs @rake db:migrate@ after creating the files.
 
 Actually, this generator calls the generators of "Rich-CMS":http://github.com/archan937/rich_cms and "Rich-i18n":http://github.com/archan937/rich_i18n. For more information, please check the README files.
 
+h4. In Rails 2
+
+Run the following in your console:
+
+<pre>
+  script/generate enrichments
+</pre>
+
 h2. Start specifying translations
 
 h3. Populating config/locales
@@ -101,7 +120,7 @@ As E9s automatically singularizes or pluralizes the translation (depending on th
 <pre>
 ---
 nl:
-  
+
   word:
     "yes":   ja
     "no":    nee
@@ -121,9 +140,9 @@ E9s provides you to specify pluralization rules for different locales. You have
 *Note*: specified in @config/locales/nl.yml@
 
 <pre>
---- 
-nl: 
-  
+---
+nl:
+
   e9s:
     singular:
       - rule:          en$
@@ -132,33 +151,33 @@ nl:
     plural:
       - rule:          ee$
         replacement:   eeën
-      
+
       - rule:          heid$
         replacement:   heden
-      
+
       - rule:          (c|m|n|t)us$
         replacement:   \1i
-      
+
       - rule:        | abc, acme, acne, (a|ë|i|o|u|y)$
         replacement:   \1's
         exceptions:    (ai|eau|ei|li|lieu|ooi|ou|shampoo|spray|vlo)$
-        
+
       - rule:          (blad|kind)$
         replacement:   \1eren
         exceptions:    (aanrecht|advertentie)blad
-      
+
       - rule:          (e|em|el|er|erd|aar|aard|um|eur|foon|oor|ier|en|ie|eau|show|festival|é)$
         replacement:   \1s
 
       - rule:        | (a|e|o|u)\1([^aeiou])$
         replacement:   \1\2en
-        
-      - rule:        | (aï|alia)(s), 
+
+      - rule:        | (aï|alia)(s),
                        ([^aeiou][aeiou])([^aeiou])$
         replacement:   \1\2\2en
-        exceptions:    dal, pad, slot, vat, weg, 
+        exceptions:    dal, pad, slot, vat, weg,
                        (blad|dag|dak|engel|gat|weg)$
-        
+
       - rule:          f$
         replacement:   ven
 
@@ -167,10 +186,10 @@ nl:
 
       - rule:          $
         replacement:   en
-    
+
     irregular:
       gelid:           gelederen
-    
+
     uncountable:
       - geld
       - informatie
@@ -188,32 +207,32 @@ You can translate @labels@ and @seatholders@ (placeholders :D) within Formtastic
 <pre>
 ---
 nl:
-  
+
   word:
     password:       wachtwoord
-  
+
   label:
     user_name:      gebruikersnaam
     content:        bericht
-    
+
     Question:
       content:      jouw vraag
-    
+
     Answer:
       content:      jouw antwoord
-    
+
     (search_form)
       criteria:     uw zoekcriteria
-  
+
   seatholder:
     email_address:  uw.naam@een.website.nl
-    
+
     Question:
       content:      Hoeveel uren zitten in een dag?
-    
+
     Answer:
       content:      24 uur
-    
+
     (search_form)
       criteria:     '&Voorbeeld'
 </pre>
@@ -345,6 +364,14 @@ We have also provided you a helper method to render Rich-CMS content tags:
   ...
 </pre>
 
+You can also render CMS content as HTML. When editing CMS content in Rich-CMS, a WYSIWYG editor will be displayed. Just add @:as => :html@.
+
+<pre>
+  ...
+  <%= rich_cms_tag ".cms_content", "application.index.welcome", :as => :html %>
+  ...
+</pre>
+
 For further documentation, please check the "Rich-CMS README":http://github.com/archan937/rich_cms file.
 
 h3. Render translations
@@ -361,7 +388,7 @@ The E9s module Rich-i18n has its own conventions which are simpler. A few exampl
   ...
 </pre>
 
-You can also render translations as HTML. When editing translations in Rich-CMS, you will be provided with a WYSIWYG editor. Simply specify @:as => :html@.
+You can also render translations as HTML. When editing translations in Rich-CMS, a WYSIWYG editor will be displayed. Just add @:as => :html@.
 
 <pre>
   ...
@@ -397,7 +424,7 @@ Rich-pluralization<br>
 
 h2. ToDo's
 
-* Make E9s compatible with Rails 3
+None
 
 h2. Enrichments
 

data/Rakefile

@@ -12,8 +12,8 @@ begin
     gemspec.homepage    = "http://codehero.es/rails_gems_plugins/e9s"
     gemspec.author      = "Paul Engel"
 
-    gemspec.add_dependency "rich_cms"          , ">= 2.0.7"
-    gemspec.add_dependency "rich_i18n"         , ">= 1.2.3"
+    gemspec.add_dependency "rich_cms"          , ">= 2.1.1"
+    gemspec.add_dependency "rich_i18n"         , ">= 1.3.1"
     gemspec.add_dependency "rich_pluralization", ">= 1.0.6"
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-2.1.4
+2.2.0

data/e9s.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{e9s}
-  s.version = "2.1.4"
+  s.version = "2.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Engel"]
-  s.date = %q{2010-10-20}
+  s.date = %q{2010-11-08}
   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 = [
@@ -29,10 +29,10 @@ Gem::Specification.new do |s|
      "lib/e9s/actionpack.rb",
      "lib/e9s/actionpack/action_view/base.rb",
      "lib/e9s/engine.rb",
+     "lib/generators/enrichments/enrichments_generator.rb",
      "rails/init.rb",
      "rails_generators/enrichments/enrichments_generator.rb",
      "tasks/e9s_tasks.rake",
-     "test/e9s_test.rb",
      "test/test_helper.rb",
      "uninstall.rb"
   ]
@@ -42,8 +42,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   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"
+    "test/test_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -51,17 +50,17 @@ 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_cms>, [">= 2.0.7"])
-      s.add_runtime_dependency(%q<rich_i18n>, [">= 1.2.3"])
+      s.add_runtime_dependency(%q<rich_cms>, [">= 2.1.1"])
+      s.add_runtime_dependency(%q<rich_i18n>, [">= 1.3.1"])
       s.add_runtime_dependency(%q<rich_pluralization>, [">= 1.0.6"])
     else
-      s.add_dependency(%q<rich_cms>, [">= 2.0.7"])
-      s.add_dependency(%q<rich_i18n>, [">= 1.2.3"])
+      s.add_dependency(%q<rich_cms>, [">= 2.1.1"])
+      s.add_dependency(%q<rich_i18n>, [">= 1.3.1"])
       s.add_dependency(%q<rich_pluralization>, [">= 1.0.6"])
     end
   else
-    s.add_dependency(%q<rich_cms>, [">= 2.0.7"])
-    s.add_dependency(%q<rich_i18n>, [">= 1.2.3"])
+    s.add_dependency(%q<rich_cms>, [">= 2.1.1"])
+    s.add_dependency(%q<rich_i18n>, [">= 1.3.1"])
     s.add_dependency(%q<rich_pluralization>, [">= 1.0.6"])
   end
 end

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

@@ -7,7 +7,7 @@ module ActionView
         if respond_to?(method = "rich_#{mod}")
           send(method)
         end
-      end.compact.join("\n")
+      end.compact.join("\n").html_safe
     end
 
   end

data/lib/e9s/engine.rb

@@ -2,7 +2,7 @@
 module E9s
   module Engine
     extend self
-    
+
     def method_missing(method, *args)
       MODULES.detect do |mod|
         m = "rich/#{mod}/engine".camelize.constantize
@@ -14,6 +14,6 @@ module E9s
 
       end
     end
-    
+
   end
 end

data/lib/e9s.rb

@@ -3,9 +3,9 @@ require "e9s/actionpack"
 
 module E9s
   extend self
-  
+
   MODULES = %w(cms i18n pluralization)
-  
+
   def require_modules
     MODULES.each do |mod|
       require "rich_#{mod}"
@@ -14,7 +14,7 @@ module E9s
     # Re-raise as RuntimeError because Mongrel would swallow LoadError.
     raise e.to_s
   end
-  
+
 end
 
 E9s.require_modules

data/lib/generators/enrichments/enrichments_generator.rb

@@ -0,0 +1,22 @@
+class EnrichmentsGenerator < Rails::Generators::Base
+
+  desc         "Creates entities used by Enrichments (e9s)"
+  class_option :user_model       , :type => :string , :default => "User"       , :aliases => "-u" , :desc => "The name of the Authlogic user model."
+  class_option :content_model    , :type => :string , :default => "CmsContent" , :aliases => "-c" , :desc => "The name of the CMS content model."
+  class_option :translation_model, :type => :string , :default => "Translation", :aliases => "-t" , :desc => "The name of the I18n translation model."
+  class_option :migrate          , :type => :boolean, :default => false        , :aliases => "-m" , :desc => "Run 'rake db:migrate' after generating model and migration"
+
+  def generate_rich_cms_files
+    generate "rich:authlogic_user", options[:user_model]
+    generate "rich:cms_content", options[:content_model]
+  end
+
+  def generate_rich_i18n_files
+    generate "rich:translation", options[:translation_model]
+  end
+
+  def migrate
+    rake "db:migrate" if options[:migrate]
+  end
+
+end

data/rails_generators/enrichments/enrichments_generator.rb

@@ -11,33 +11,13 @@ class EnrichmentsGenerator < Rails::Generator::Base
       # 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
+    system "rake db:migrate" if options[:migrate]
   end
 
 protected
@@ -50,7 +30,7 @@ protected
     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).

data/test/test_helper.rb

@@ -1,3 +1,6 @@
 require "rubygems"
+require "test/unit"
 require "active_support"
-require "active_support/test_case"
+
+require File.join(File.dirname(__FILE__), "..", "lib", "e9s")
+include E9s

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: e9s
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 7
   prerelease: false
   segments: 
   - 2
-  - 1
-  - 4
-  version: 2.1.4
+  - 2
+  - 0
+  version: 2.2.0
 platform: ruby
 authors: 
 - Paul Engel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-20 00:00:00 +02:00
+date: 2010-11-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,12 +26,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 9
         segments: 
         - 2
-        - 0
-        - 7
-        version: 2.0.7
+        - 1
+        - 1
+        version: 2.1.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -45,9 +45,9 @@ dependencies:
         hash: 25
         segments: 
         - 1
-        - 2
         - 3
-        version: 1.2.3
+        - 1
+        version: 1.3.1
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -88,10 +88,10 @@ files:
 - lib/e9s/actionpack.rb
 - lib/e9s/actionpack/action_view/base.rb
 - lib/e9s/engine.rb
+- lib/generators/enrichments/enrichments_generator.rb
 - rails/init.rb
 - rails_generators/enrichments/enrichments_generator.rb
 - tasks/e9s_tasks.rake
-- test/e9s_test.rb
 - test/test_helper.rb
 - uninstall.rb
 has_rdoc: true
@@ -129,5 +129,4 @@ signing_key:
 specification_version: 3
 summary: Enrichments (e9s) for a pluggable CMS, internationalization (i18n) and localized pluralization
 test_files: 
-- test/e9s_test.rb
 - test/test_helper.rb

data/test/e9s_test.rb

@@ -1,8 +0,0 @@
-require "test_helper"
-
-class E9sTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
-  end
-end