copycat 0.0.2 → 0.0.3

data/README.md

@@ -9,7 +9,7 @@ Add ```copycat``` to your Gemfile and run bundle.
 Copycat uses a database table to store the copy items, and so it is necessary to create that:
 
 ```
-rake copycat_engine:install:migrations
+rake copycat:install
 rake db:migrate
 ```
 
@@ -24,7 +24,7 @@ Visit the page in your browser, and a Copycat translation will be created for th
 
 ## Rails i18N API ##
 
-You can read about the Rails internationalization framework [here](http://guides.rubyonrails.org/i18n.html). Copycat 
+You can read about the Rails internationalization framework [here](http://guides.rubyonrails.org/i18n.html).
 
 ## Deploying ##
 
@@ -37,7 +37,7 @@ As a Rails engine, Copycat is developed using a nested dummy Rails app. After cl
 ```
 bundle
 cd spec/dummy
-rake copycat_engine:install:migrations
+rake copycat:install
 rake db:create db:migrate db:test:prepare
 cd ../..
 ```

data/app/assets/stylesheets/{copycat/copycat.css → copycat_engine.css}

@@ -1,11 +1,20 @@
-#copycat li, #copycat li h2 {
-  display: inline;
-  padding: 2em;
+body.copycat {
+  margin: 0;
 }
-#copycat table, #copycat div.copycat-alert, #copycat div.copycat-notice, div#readme, div#upload {
+div#copycat { 
   width: 75%;
-  margin-left: 12.5%;
-  margin-right: 12.5%;
+  margin-left: 10.5%;
+  padding-left: 2%;
+  margin-right: 10.5%;
+  padding-right: 2%;
+}
+#copycat ul {
+  padding-left: 0;
+  padding-top: 2em;
+}
+#copycat li, #copycat li h2 {
+  display: inline;
+  padding-right: 4em;
 }
 #copycat table, #copycat form, #copycat div.copycat-alert, #copycat div.copycat-notice, div#readme, div#upload {
   padding-top: 2em;
@@ -23,12 +32,10 @@
   padding-bottom: 1em;
   border-top: 1px #CCC dotted;
 }
-#copycat table tr td.last {
-  border-bottom: none;
-}
 #copycat table tr td.key {
   width: 20%;
   margin-right: 5%;
+  vertical-align: top;
 }
 #copycat table tr td.value {
   width: 75%;

data/app/controllers/copycat_translations_controller.rb

@@ -1,4 +1,8 @@
 class CopycatTranslationsController < ApplicationController
+  
+  http_basic_authenticate_with :name => COPYCAT_USERNAME, :password => COPYCAT_PASSWORD
+
+  layout 'copycat'
 
   def index
     @copycat_translations = CopycatTranslation.all

data/app/models/copycat_translation.rb

@@ -1,7 +1,6 @@
 class CopycatTranslation < ActiveRecord::Base
 
-  validates :key, :value, :presence => true
-  validates :key, :uniqueness => true
+  validates :key, :presence => true, :uniqueness => true
   
   def self.import_yaml(yaml)
     hash = YAML.load(yaml)

data/app/views/copycat_translations/_copycat_header.html.erb

@@ -0,0 +1,9 @@
+<div class="copycat-header">
+<ul>
+  <li><a href=<%=copycat_translations_path%>><h2>Copycat</h2></a></li>
+  <% href = copycat_translations_path + ".yaml" %>
+  <li><a href=<%=href%>>Download</a></li>
+  <li><a href=<%= upload_copycat_translations_path %>>Upload</a></li>
+  <li><a href=<%= readme_copycat_translations_path %>>Readme</a></li>
+</ul>
+</div>

data/app/views/copycat_translations/index.html.erb

@@ -1,11 +1,3 @@
-<div id="copycat">
-<ul>
-  <li><h2>Copycat</h2></li>
-  <% href = copycat_translations_path + ".yaml" %>
-  <li><a href=<%=href%>>Download</a></li>
-  <li><a href=<%= upload_copycat_translations_path %>>Upload</a></li>
-  <li><a href=<%= readme_copycat_translations_path %>>Readme</a></li>
-</ul>
 <div class="copycat-notice"> <%= notice %> </div>
 <table>
   <tr>
@@ -23,4 +15,3 @@
   </tr>
   <% end %>
 </table>
-</div>

data/app/views/copycat_translations/readme.html.erb

@@ -1,41 +1,30 @@
-<div id="copycat">
-<ul>
-  <li><h2>Copycat</h2></li>
-  <% href = copycat_translations_path %>
-  <li><a href=<%=href%>>Back</a></li>
-</ul>
+<div id="readme">
 
-  <div id="readme">
-
-    <div class="section">
-      <h2> Copycat </h2>
-      <p>Copycat is a Ruby on Rails engine that allows you to edit live website copy.</p>
-    </div>
-
-    <div class="section">
-      <h2> How to use </h2>
-      <p>The values you see here correspond to literal HTML copy text in different parts of the parent website. When you edit them, the text on the website will change. Use ctrl-f or command-f to search for text, then click the left hand side links to edit. </p>
-    </div>
+  <div class="section">
+    <h2> Copycat </h2>
+    <p>Copycat is a Ruby on Rails engine that allows you to edit live website copy.</p>
+  </div>
 
-    <div class="section">
-      <h2> Complicated stuff </h2>
-      <p> Copycat text is data--not code. By default, Copycat values are stored in your server's database, and not the code base that powers your website.</p> 
-      <p> What this means is that you may have to download/upload Copycat data to transfer your copy edits between servers, or to safeguard them between database wipes.  </p>
-      <p>Copycat accomplishes this by exporting (and being able to re-import) all of its data in a format called "YAML."</p> 
-      <h4> Downloading </h4>
-      <p>You can get a YAML file of all your copy by clicking "Download" on the main Copycat page.</p>
-      <h4> Uploading </h4>
-      <p>You can upload copy to Copycat by clicking "Upload" on the main page and uploading a properly formatted YAML file. Uploading copy won't delete any entries from Copycat, but it may update them or create new ones. Use this feature to mass-update your copy from between servers -- e.g., make changes to copy on a test server, and then when you're satisfied, download the YAML file and upload it to your production site.</p>
-      <p>Downloading your copy as YAML and then immediately re-uploading it will leave your copy unchanged.</p>
-      <h4> Commiting your data to your codebase </h4>
-      <p>If you're pretty happy with your copy and don't expect to need to update it live anymore, or just want a bit more security, you can download your copy as YAML and include it as part of the Ruby on Rails application underneath your main website. You can then remove Copycat from the application entirely, and the website will still run exactly as before--it interfaces with Ruby on Rails's built-in mechanisms in a very unobtrusive way.
-    </div>
+  <div class="section">
+    <h2> How to use </h2>
+    <p>The values you see here correspond to literal HTML copy text in different parts of the parent website. When you edit them, the text on the website will change. Use ctrl-f or command-f to search for text, then click the left hand side links to edit. </p>
+  </div>
 
-    <div class="section">
-      <h2> About </h2>
-      <p>Copycat is a product of <a href="http://www.vermonster.com">Vermonster LLC</a>. Thanks for using!</p>
-    </div>
+  <div class="section">
+    <h2> Importing and Exporting </h2>
+    <p> Copycat text is data--not code. By default, Copycat values are stored in your server's database, and not the codebase that powers your website. Therefore, you may have to download/upload Copycat data to transfer your copy edits between servers, or to safeguard them between database wipes. Copycat exports (and is able to re-import) all of its data in a format called "YAML."</p> 
+    <h4> Downloading </h4>
+    <p>You can get a YAML file of all your copy by clicking "Download" on the main Copycat page.</p>
+    <h4> Uploading </h4>
+    <p>You can upload copy to Copycat by clicking "Upload" on the main page and uploading a properly formatted YAML file. Uploading copy won't delete any entries from Copycat, but it may update them or create new ones. Use this feature to mass-update your copy from between servers -- e.g., make changes to copy on a test server, and then when you're satisfied, download the YAML file and upload it to your production site. Downloading your copy as YAML and then immediately re-uploading it will leave your copy unchanged.</p>
+    <h4> Commiting copy to your codebase </h4>
+    <p>If you're pretty happy with your copy and don't expect to need to update it live anymore, or just want a bit more security, you can download your copy as YAML and include it as part of the Ruby on Rails application underneath your main website. You can then remove Copycat from the application entirely, and the website will still run exactly as before--it interfaces with Ruby on Rails's built-in translation mechanisms in a very unobtrusive way.
+  </div>
 
+  <div class="section">
+    <h2> About </h2>
+    <p>Copycat is a product of <a href="http://www.vermonster.com">Vermonster LLC</a>. Thanks for using!</p>
   </div>
 
 </div>
+

data/app/views/copycat_translations/upload.html.erb

@@ -1,18 +1,11 @@
-<div id="copycat">
-<ul>
-  <li><h2>Copycat</h2></li>
-  <% href = copycat_translations_path %>
-  <li><a href=<%=href%>>Back</a></li>
-</ul>
 <div id="upload">
   <p>
   Upload a YAML (.yml) file following <a href="http://guides.rubyonrails.org/i18n.html">I18n conventions</a>. 
   </p>
-  <%= form_tag 'import_yaml', :multipart => true do -%>
+  <%= form_tag 'import_yaml', :multipart => true, :'accept-charset' => 'UTF-8' do -%>
     <%= file_field_tag "file" %>
     <%= submit_tag "Upload" %>
   <% end %>
   <div class="copycat-alert"> <%= notice %> </div>
 </div>
-</div>
 

data/app/views/layouts/copycat.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Copycat</title>
+  <%= stylesheet_link_tag "copycat_engine", :media => "all" %>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+</head>
+<body class="copycat">
+  <div id="copycat">
+    <%= render :partial => "copycat_header" %>
+    <%= yield %>
+  </div>
+
+</body>
+</html>

data/db/migrate/20120313191745_create_copycat_translations.rb

@@ -1,10 +1,13 @@
 class CreateCopycatTranslations < ActiveRecord::Migration
   def up
     create_table :copycat_translations do |t|    
-      t.string "key"
-      t.text "value"
+      t.string :key
+      t.text :value
       t.timestamps
     end
+    change_table :copycat_translations do |t|
+      t.index :key
+    end
   end
 
   def down

data/lib/copycat/version.rb

@@ -1,3 +1,3 @@
 module Copycat
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/copycat.rb

@@ -24,11 +24,20 @@ from i18n gem, lib/i18n/backend/simple.rb
 =end
 module CopycatImplementation
   def lookup(locale, key, scope = [], options = {})
-    cct = CopycatTranslation.find_by_key(key)
-    return cct.value if cct
-    value = super(locale, key, scope = [], options = {}) || key
-    CopycatTranslation.create(key: key, value: value)
-    value
+    begin
+      cct = CopycatTranslation.find_by_key(key)
+    rescue ActiveRecord::StatementInvalid
+      raise if CopycatTranslation.table_exists?
+      #assert Rails is initializing for the purpose of running the copycat_translations migration
+      super 
+    else
+      return cct.value if cct
+      value = super(locale, key, scope, options)
+      if value.is_a?(String) || value.nil?
+        CopycatTranslation.create(key: key, value: value)
+      end
+      value
+    end
   end
 end
 

data/lib/tasks/copycat_tasks.rake

@@ -1,4 +1,26 @@
-# desc "Explaining what the task does"
-# task :copycat do
-#   # Task goes here
-# end
+namespace :copycat do
+  desc "Install the plugin, including the migration."
+  task :install do
+    Rake::Task["copycat_engine:install:migrations"].invoke
+    Rake::Task["copycat:install_initializer"].invoke
+  end
+
+  task :install_initializer do
+    require 'digest'
+    username = (Digest::SHA2.new << rand.to_s).to_s[0..6]
+    password = (Digest::SHA2.new << rand.to_s).to_s[0..6]
+    filepath = Rails.root.join *%w(config initializers copycat.rb)
+    File.open(filepath, 'w') do |f|
+      f << <<-CONFIG
+COPYCAT_USERNAME = "#{username}"
+COPYCAT_PASSWORD = "#{password}"
+        CONFIG
+    end
+    puts <<-INFO
+Copycat initializer created with
+  username: #{username}
+  password: #{password}
+Now run 'rake db:migrate'.
+    INFO
+  end
+end

data/spec/dummy/config/initializers/copycat.rb

@@ -0,0 +1,2 @@
+COPYCAT_USERNAME = "ec1c2b9"
+COPYCAT_PASSWORD = "acca43c"

data/spec/dummy/db/migrate/{20120313192639_create_copycat_translations.copycat_engine.rb → 20120316153248_create_copycat_translations.copycat_engine.rb}

@@ -2,10 +2,13 @@
 class CreateCopycatTranslations < ActiveRecord::Migration
   def up
     create_table :copycat_translations do |t|    
-      t.string "key"
-      t.text "value"
+      t.string :key
+      t.text :value
       t.timestamps
     end
+    change_table :copycat_translations do |t|
+      t.index :key
+    end
   end
 
   def down

data/spec/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 => 20120313192639) do
+ActiveRecord::Schema.define(:version => 20120316153248) do
 
   create_table "copycat_translations", :force => true do |t|
     t.string   "key"
@@ -20,4 +20,6 @@ ActiveRecord::Schema.define(:version => 20120313192639) do
     t.datetime "updated_at", :null => false
   end
 
+  add_index "copycat_translations", ["key"], :name => "index_copycat_translations_on_key"
+
 end