ominous 0.0.4 → 0.0.5

data/README.rdoc

@@ -71,26 +71,19 @@ For example:
 
 == Warning text
 
-Warnings contain a title and description. Closers contain a message and a link.
-The text used for each needs to be defined in your locale file.
-
-For the something_happened warning used above
-the entry needs to look like this:
-
-    en:
-
-      ominous:
-        warning:
-          something_happened:
-            title: Warning
-            description: You have triggered a warning.
-            closer_one:
-              message: This is the first closer
-              link: Click here to activate closer_one
-            closer_two:
-              message: This is the second closer
-              link: Click here to activate closer_two
+Warnings contain a title and description. Closers contain a message and link_text.
+These elements will be displayed within the warning message. See:
 
+  app/views/ominous/warnings/_list.html.erb
+
+Default text will appear if these fields are empty. These defaults being the
+minimum needed to generate a usable warning message.
+
+If warning#title is blank, a humanized version of the warning name will be 
+displayed.
+
+If closer.link_text is blank, the closer's link text will be constructed from
+the closure_method.
 
 == Managing warnings
 

data/app/helpers/ominous/warnings_helper.rb

@@ -11,7 +11,7 @@ module Ominous
     end
     
     def closer_link_to(warning, closer)
-      text = t("ominous.warning.#{warning.name}.#{closer.name}.link") 
+      text = closer.link_text 
       link_class = closer.closure_method
       url = closer_url(warning, closer)
       link_to(text, url, :method => :put, :class => link_class)

data/app/models/ominous/closer.rb

@@ -1,6 +1,6 @@
 module Ominous
   class Closer < ActiveRecord::Base
-    attr_accessible :name, :url, :closure_method, :start_hidden
+    attr_accessible :name, :url, :closure_method, :start_hidden, :message, :link_text
     
     CLOSURE_METHODS = {
       :reveal_hidden => 'Hides the current closers and reveals any hidden closers', 
@@ -14,6 +14,10 @@ module Ominous
     def self.closure_methods
       CLOSURE_METHODS
     end
+    
+    def link_text
+      super.blank? ? "click here to #{closure_method}".humanize : super
+    end
 
   end
 end

data/app/models/ominous/warning.rb

@@ -1,6 +1,6 @@
 module Ominous
   class Warning < ActiveRecord::Base
-    attr_accessible :name, :closers_attributes
+    attr_accessible :name, :closers_attributes, :title, :description
     
     validates :name, :presence => true
     
@@ -39,6 +39,10 @@ module Ominous
       clear_requests # So that warnings called while processing one action are not carried over to the next where they may not be relevant
     end
     
+    def title
+      super.blank? ? name.humanize : super
+    end
+    
     private
     def method_missing(symbol, *args, &block)
       if acts_as_list_method?(symbol)

data/app/views/ominous/warnings/_list.html.erb

@@ -1,15 +1,15 @@
 <% warnings.each do |warning| %>
 <div class="warning">
   <div class="heading">
-    <h2><%= t("ominous.warning.#{warning.name}.title") %></h2>
+    <h2><%= warning.title %></h2>
   </div>
   <div class="description">
-    <%= t("ominous.warning.#{warning.name}.description") %>
+    <%= sanitize warning.description %>
   </div>
   <div class="closers">
 <%   warning.closers.each do |closer| %> 
     <div class="<%= classes_for(closer)  %>">
-      <p><%=  t("ominous.warning.#{warning.name}.#{closer.name}.message") %></p>
+      <p><%= sanitize closer.message %></p>
       <p>
         <%= closer_link_to(warning, closer) %>
       </p>

data/db/migrate/20130131131756_add_title_and_description_to_ominous_warnings.rb

@@ -0,0 +1,6 @@
+class AddTitleAndDescriptionToOminousWarnings < ActiveRecord::Migration
+  def change
+    add_column :ominous_warnings, :title, :string
+    add_column :ominous_warnings, :description, :text
+  end
+end

data/db/migrate/20130131131934_add_link_text_and_message_to_ominous_closers.rb

@@ -0,0 +1,6 @@
+class AddLinkTextAndMessageToOminousClosers < ActiveRecord::Migration
+  def change
+    add_column :ominous_closers, :link_text, :string
+    add_column :ominous_closers, :message, :text
+  end
+end

data/lib/ominous/version.rb

@@ -1,3 +1,28 @@
 module Ominous
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end
+
+# History
+# =======
+# 
+# 0.0.5
+# -----
+# Moved text decoration of warnings and closers to models. 
+# 
+# Upgrading to this version requires a migration:
+# 
+#     rake ominous:install:migrations
+#     rake db:migrate
+# 
+# In use, the separation of text (in translations) from the warning objects was 
+# confusing. It proved difficult for users to create new warning, and match them 
+# to translations.
+# 
+# By using a more standard arrangement, translation options can be added to the
+# host app, where all text output can be handled the same way, and therefore
+# users will be familiar with the process of updating text.
+# 
+# 0.0.4
+# -----
+# First working version. No history before this version.
+#

data/test/dummy/config/database.yml

@@ -1,18 +1,17 @@
 
 defaults: &defaults
-  adapter: mysql2
-  username: rails_app
-  password: GTYHdse23B
-  host: localhost
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
 
 development:
   <<: *defaults
-  database: ominous_development
+  database: db/development.sqlite3
 
 test:
   <<: *defaults
-  database: ominous_test
+  database: db/test.sqlite3
 
 production:
   <<: *defaults
-  database: ominous
+  database: db/production.sqlite3

data/test/dummy/config/locales/en.yml

@@ -3,18 +3,3 @@
 
 en:
   hello: "Hello world"
-  
-  ominous:
-    warning:
-      thing_alert:
-        title: Warning
-        description: You have viewed a Thing with it's warning set.
-        closer_one:
-          message: This should not appear initially
-          link: Click here to close the warning and tell the server not to show it again
-        closer_two:
-          message: This will redirect to another site
-          link: Click to go elsewhere
-        closer_three:
-          message: This should appear initially
-          link: Click here to see hidden closers

data/test/dummy/db/migrate/20130131134020_create_ominous_warnings.ominous.rb

@@ -0,0 +1,9 @@
+# This migration comes from ominous (originally 20121206144249)
+class CreateOminousWarnings < ActiveRecord::Migration
+  def change
+    create_table :ominous_warnings do |t|
+      t.column :name, :string
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20130131134021_create_ominous_warning_closers.ominous.rb

@@ -0,0 +1,11 @@
+# This migration comes from ominous (originally 20121206145743)
+class CreateOminousWarningClosers < ActiveRecord::Migration
+  def change
+    create_table :ominous_warning_closers do |t|
+      t.column :warning_id, :integer
+      t.column :closer_id, :integer
+      t.column :position, :integer
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20130131134022_create_ominous_closers.ominous.rb

@@ -0,0 +1,12 @@
+# This migration comes from ominous (originally 20121206153254)
+class CreateOminousClosers < ActiveRecord::Migration
+  def change
+    create_table :ominous_closers do |t|
+      t.column :name, :string
+      t.column :url, :string
+      t.column :closure_method, :string, :limit => 30
+      t.column :start_hidden, :boolean, :default => false
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20130131134023_add_title_and_description_to_ominous_warnings.ominous.rb

@@ -0,0 +1,7 @@
+# This migration comes from ominous (originally 20130131131756)
+class AddTitleAndDescriptionToOminousWarnings < ActiveRecord::Migration
+  def change
+    add_column :ominous_warnings, :title, :string
+    add_column :ominous_warnings, :description, :text
+  end
+end

data/test/dummy/db/migrate/20130131134024_add_link_text_and_message_to_ominous_closers.ominous.rb

@@ -0,0 +1,7 @@
+# This migration comes from ominous (originally 20130131131934)
+class AddLinkTextAndMessageToOminousClosers < ActiveRecord::Migration
+  def change
+    add_column :ominous_closers, :link_text, :string
+    add_column :ominous_closers, :message, :text
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20121207090710) do
+ActiveRecord::Schema.define(:version => 20130131134024) do
 
   create_table "ominous_closers", :force => true do |t|
     t.string   "name"
@@ -20,6 +20,8 @@ ActiveRecord::Schema.define(:version => 20121207090710) do
     t.boolean  "start_hidden",                 :default => false
     t.datetime "created_at",                                      :null => false
     t.datetime "updated_at",                                      :null => false
+    t.string   "link_text"
+    t.text     "message"
   end
 
   create_table "ominous_warning_closers", :force => true do |t|
@@ -32,8 +34,10 @@ ActiveRecord::Schema.define(:version => 20121207090710) do
 
   create_table "ominous_warnings", :force => true do |t|
     t.string   "name"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at",  :null => false
+    t.datetime "updated_at",  :null => false
+    t.string   "title"
+    t.text     "description"
   end
 
   create_table "things", :force => true do |t|

data/test/dummy/db/seeds/ominous/closers.yml

@@ -1,11 +1,16 @@
 closer_one:
   closure_method: close_and_dismiss_warning
   start_hidden: true
+  message: This should not appear initially
+  link_text: Click here to close the warning and tell the server not to show it again
 
 closer_two:
   url: http://undervale.co.uk
   closure_method: redirect
+  message: This will redirect to another site
+  link_text: Click to go elsewhere
   
 closer_three:
   closure_method: reveal_hidden
-  
+  message: This should appear initially
+  link_text: Click here to see hidden closers

data/test/dummy/db/seeds/ominous/warnings.yml

@@ -1 +1,3 @@
-thing_alert:
+thing_alert:
+  title: Warning
+  description: You have viewed a Thing with it's warning set.