copycat 0.0.1 → 0.0.2

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 YOURNAME
+Copyright 2012 Andrew Ross
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,53 @@
+# Copycat #
+
+Copycat is a Rails engine that allows editing live website copy.
+
+## How to use ##
+
+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 db:migrate
+```
+
+In a view, use the Rails i18N.translate() method where you would like to display some editable copy:
+
+
+```erb
+<h1><%= t('site.index.header') %></h1>
+```
+
+Visit the page in your browser, and a Copycat translation will be created for the key. Then visit '/copycat_translations' in your browser and you can edit the value of that token.
+
+## Rails i18N API ##
+
+You can read about the Rails internationalization framework [here](http://guides.rubyonrails.org/i18n.html). Copycat 
+
+## Deploying ##
+
+
+
+## Developing ##
+
+As a Rails engine, Copycat is developed using a nested dummy Rails app. After cloning the repository and running bundler, the plugin must be installed in the dummy app:
+
+```
+bundle
+cd spec/dummy
+rake copycat_engine:install:migrations
+rake db:create db:migrate db:test:prepare
+cd ../..
+```
+
+Now you can run the test suite:
+
+```
+rspec spec/
+```
+
+## License ##
+
+Copycat is released under the MIT license. See MIT-LICENSE file.

data/Rakefile

@@ -20,19 +20,9 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task :default => :test
+task :default => :spec

data/app/assets/stylesheets/copycat/copycat.css

@@ -0,0 +1,44 @@
+#copycat li, #copycat li h2 {
+  display: inline;
+  padding: 2em;
+}
+#copycat table, #copycat div.copycat-alert, #copycat div.copycat-notice, div#readme, div#upload {
+  width: 75%;
+  margin-left: 12.5%;
+  margin-right: 12.5%;
+}
+#copycat table, #copycat form, #copycat div.copycat-alert, #copycat div.copycat-notice, div#readme, div#upload {
+  padding-top: 2em;
+}
+#copycat table {
+  border-bottom: 1px #CCC dotted;
+  padding-bottom: 1em;
+}
+#copycat table th {
+  text-align: left;
+  padding-bottom: 1em;
+}
+#copycat table tr td {
+  padding-top: 1em;
+  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%;
+}
+#copycat table tr td.value {
+  width: 75%;
+}
+#copycat div.copycat-alert {
+  color: red;
+  font-weight: bold;
+}
+#copycat div.copycat-notice {
+  color: green;
+  font-weight: bold;
+}
+

data/app/controllers/copycat_translations_controller.rb

@@ -0,0 +1,45 @@
+class CopycatTranslationsController < ApplicationController
+
+  def index
+    @copycat_translations = CopycatTranslation.all
+    respond_to do |format|
+      format.html
+      format.yaml { send_data CopycatTranslation.export_yaml, :filename => "copycat_translations_#{Time.now.strftime("%Y_%m_%d_%H_%M_%S")}.yml" }
+    end
+  end
+
+  def edit
+    @copycat_translation = CopycatTranslation.find_by_id(params["id"])
+  end
+  
+  def update
+    cct = CopycatTranslation.find_by_id(params["id"])
+    cct.value = params["copycat_translation"]["value"]
+    if cct.save
+      #Copycat.clear_cache(params["copycat_translation"]["key"])
+      @copycat_translations = CopycatTranslation.all
+      redirect_to copycat_translations_path
+    else
+      @copycat_translation = cct
+      render :action => 'edit'
+    end
+  end
+
+  def readme
+  end
+
+  def upload
+  end
+
+  def import_yaml
+    begin
+      CopycatTranslation.import_yaml(params["file"].tempfile)
+    rescue StandardError => e
+      flash[:notice] = "There was an error processing your upload!"
+      render :action => 'upload', :status => 400
+    else
+      redirect_to copycat_translations_path, :notice => "YAML file uploaded successfully!"
+    end
+  end
+
+end

data/app/models/copycat_translation.rb

@@ -0,0 +1,27 @@
+class CopycatTranslation < ActiveRecord::Base
+
+  validates :key, :value, :presence => true
+  validates :key, :uniqueness => true
+  
+  def self.import_yaml(yaml)
+    hash = YAML.load(yaml)
+    hash.each do |locale, data|
+      next unless locale == "en" # not handling non-english languages yet.
+      Copycat.hash_flatten(data).each do |key, value|
+        c = find_or_initialize_by_key(key)
+        c.value = value
+        c.save
+        #Copycat.clear_cache
+      end
+    end
+  end
+
+  def self.export_yaml
+    yaml_hash = {}
+    all.each do |c|
+      yaml_hash = Copycat.hash_fatten(yaml_hash, c.key.split("."), c.value)
+    end
+    {"en" => yaml_hash}.to_yaml
+  end
+
+end

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

@@ -0,0 +1,7 @@
+<%= form_for @copycat_translation, :url => { :action => "update" }, :html => {:class => "copycat_translation"} do |f| %>
+  <%= @copycat_translation.key %>
+  <br>
+  <%= f.text_area :value, :size => "60x12" %>
+  <br>
+  <%= f.submit "Update" %>
+<% end %>

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

@@ -0,0 +1,26 @@
+<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>
+    <th> Key </th>
+    <th> Value </th>
+  </tr>
+  <% @copycat_translations.each do |t| %>
+  <tr>
+    <td class="key">
+      <%= link_to t.key, edit_copycat_translation_path(t) %>
+    </td>
+    <td class="value">
+      <%= t.value %>
+    </td>
+  </tr>
+  <% end %>
+</table>
+</div>

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

@@ -0,0 +1,41 @@
+<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 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> 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> About </h2>
+      <p>Copycat is a product of <a href="http://www.vermonster.com">Vermonster LLC</a>. Thanks for using!</p>
+    </div>
+
+  </div>
+
+</div>

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

@@ -0,0 +1,18 @@
+<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 -%>
+    <%= file_field_tag "file" %>
+    <%= submit_tag "Upload" %>
+  <% end %>
+  <div class="copycat-alert"> <%= notice %> </div>
+</div>
+</div>
+

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  resources :copycat_translations, :only => [:index, :edit, :update] do
+    get 'readme', :on => :collection
+    get 'upload', :on => :collection
+    post 'import_yaml', :on => :collection
+  end
+end

data/db/migrate/20120313191745_create_copycat_translations.rb

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

data/lib/copycat/engine.rb

@@ -0,0 +1,4 @@
+module Copycat
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/copycat/version.rb

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

data/lib/copycat.rb

@@ -1,2 +1,93 @@
+require "copycat/engine"
+
+=begin
+from i18n gem, lib/i18n/backend/simple.rb
+
+  # Looks up a translation from the translations hash. Returns nil if
+  # eiher key is nil, or locale, scope or key do not exist as a key in the
+  # nested translations hash. Splits keys or scopes containing dots
+  # into multiple keys, i.e. <tt>currency.format</tt> is regarded the same as
+  # <tt>%w(currency format)</tt>.
+  def lookup(locale, key, scope = [], options = {})
+    init_translations unless initialized?
+    keys = I18n.normalize_keys(locale, key, scope, options[:separator])
+
+    keys.inject(translations) do |result, _key|
+      _key = _key.to_sym
+      return nil unless result.is_a?(Hash) && result.has_key?(_key)
+      result = result[_key]
+      result = resolve(locale, _key, result, options.merge(:scope => nil)) if result.is_a?(Symbol)
+      result
+    end
+  end
+
+=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
+  end
+end
+
+class I18n::Backend::Simple
+  include CopycatImplementation
+end
+
 module Copycat
+
+  # {"foo"=>{"a"=>"1", "b"=>"2"}} ----> {"foo.a"=>1, "foo.b"=>2}
+  def self.hash_flatten(hash)
+    result = {} 
+    hash.each do |key, value|
+      if value.is_a? Hash 
+        hash_flatten(value).each { |k,v| result["#{key}.#{k}"] = v }
+      else 
+        result[key] = value
+      end
+    end
+    result
+  end
+
+  # ({"a"=>{"b"=>{"e"=>"f"}}}, ["a","b","c"], "d") ----> {"a"=>{"b"=>{"c"=>"d", "e"=>"f"}}}
+  def self.hash_fatten(hash, keys, value)
+    if keys.length == 1
+      raise "duplicate key" if hash[keys.first]
+      hash[keys.first] = value
+    else
+      head = keys.first
+      rest = keys[1..-1]
+      hash[head] = hash_fatten(hash[head] || {}, rest, value)
+    end
+    hash
+  end
+
+
+=begin
+  def self.cache
+    @cache ||= {}
+  end
+
+  def self.t(key)
+    if cache[key]
+      cache[key].html_safe
+    else 
+      copybar = CopycatTranslation.where("key = '#{key}'").limit(1).first
+      copybar = CopycatTranslation.create!(:key => key, :value => "Missing copy for #{key}") unless copybar
+      cache[key] = copybar.value
+      copybar.value.html_safe 
+    end
+  end
+
+  def self.clear_cache(key=nil)
+    if key
+      cache[key] = nil
+    else
+      @cache = {}
+    end
+  end
+=end
+
 end

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/spec/dummy/app/assets/stylesheets/copycat.css

@@ -0,0 +1,44 @@
+#copycat li, #copycat li h2 {
+  display: inline;
+  padding: 2em;
+}
+#copycat table, #copycat div.copycat-alert, #copycat div.copycat-notice, div#readme, div#upload {
+  width: 75%;
+  margin-left: 12.5%;
+  margin-right: 12.5%;
+}
+#copycat table, #copycat form, #copycat div.copycat-alert, #copycat div.copycat-notice, div#readme, div#upload {
+  padding-top: 2em;
+}
+#copycat table {
+  border-bottom: 1px #CCC dotted;
+  padding-bottom: 1em;
+}
+#copycat table th {
+  text-align: left;
+  padding-bottom: 1em;
+}
+#copycat table tr td {
+  padding-top: 1em;
+  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%;
+}
+#copycat table tr td.value {
+  width: 75%;
+}
+#copycat div.copycat-alert {
+  color: red;
+  font-weight: bold;
+}
+#copycat div.copycat-notice {
+  color: green;
+  font-weight: bold;
+}
+

data/spec/dummy/app/controllers/site_controller.rb

@@ -0,0 +1,5 @@
+class SiteController < ApplicationController
+  def index
+
+  end
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag "application", :media => "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/site/index.html.erb

@@ -0,0 +1,3 @@
+<h2><%= t('site.index.header') %></h2>
+
+<div><%= t('site.index.intro') %></div> 

data/{test → spec}/dummy/config/application.rb

@@ -35,17 +35,6 @@ module Dummy
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]
 
-    # Use SQL instead of Active Record's schema dumper when creating the database.
-    # This is necessary if your schema can't be completely dumped by the schema dumper,
-    # like if you have constraints or database-specific column types
-    # config.active_record.schema_format = :sql
-
-    # Enforce whitelist mode for mass assignment.
-    # This will create an empty whitelist of attributes available for mass-assignment for all models
-    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
-    # parameters by using an attr_accessible or attr_protected declaration.
-    # config.active_record.whitelist_attributes = true
-
     # Enable the asset pipeline
     config.assets.enabled = true
 

data/{test → spec}/dummy/config/environments/development.rb

@@ -2,7 +2,7 @@ Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
 
   # In the development environment your application's code is reloaded on
-  # every request. This slows down response time but is perfect for development
+  # every request.  This slows down response time but is perfect for development
   # since you don't have to restart the web server when you make code changes.
   config.cache_classes = false
 
@@ -22,13 +22,6 @@ Dummy::Application.configure do
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
 
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
-
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
-
   # Do not compress assets
   config.assets.compress = false
 

data/{test → spec}/dummy/config/environments/production.rb

@@ -33,11 +33,8 @@ Dummy::Application.configure do
   # See everything in the log (default is :info)
   # config.log_level = :debug
 
-  # Prepend all log lines with the following tags
-  # config.log_tags = [ :subdomain, :uuid ]
-
   # Use a different logger for distributed setups
-  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+  # config.logger = SyslogLogger.new
 
   # Use a different cache store in production
   # config.cache_store = :mem_cache_store
@@ -60,8 +57,4 @@ Dummy::Application.configure do
 
   # Send deprecation notices to registered listeners
   config.active_support.deprecation = :notify
-
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  # config.active_record.auto_explain_threshold_in_seconds = 0.5
 end

data/{test → spec}/dummy/config/environments/test.rb

@@ -2,9 +2,9 @@ Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb
 
   # The test environment is used exclusively to run your application's
-  # test suite. You never need to work with it otherwise. Remember that
+  # test suite.  You never need to work with it otherwise.  Remember that
   # your test database is "scratch space" for the test suite and is wiped
-  # and recreated between test runs. Don't rely on the data there!
+  # and recreated between test runs.  Don't rely on the data there!
   config.cache_classes = true
 
   # Configure static asset server for tests with Cache-Control for performance
@@ -29,8 +29,10 @@ Dummy::Application.configure do
   # ActionMailer::Base.deliveries array.
   config.action_mailer.delivery_method = :test
 
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr

data/{test → spec}/dummy/config/initializers/inflections.rb

@@ -8,8 +8,3 @@
 #   inflect.irregular 'person', 'people'
 #   inflect.uncountable %w( fish sheep )
 # end
-#
-# These inflection rules are supported but not enabled by default:
-# ActiveSupport::Inflector.inflections do |inflect|
-#   inflect.acronym 'RESTful'
-# end

data/{test → spec}/dummy/config/initializers/secret_token.rb

@@ -4,4 +4,4 @@
 # If you change this key, all old signed cookies will become invalid!
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
-Dummy::Application.config.secret_token = 'adbe3a77ddb042668f7f41d2eea20fc84f54d44fcf16be17834b0a40553126d60de42e8b969d603a58cdf865f2c5d95ed5d8866332989d61256197221e20541f'
+Dummy::Application.config.secret_token = '58a2a6a84d84c3e438f9ca2616323039174f7da3337e52de287033934caa5d32051779feec0aba01731cd4811d60150b208b856b706bee47f510c8a0648f1600'

data/{test → spec}/dummy/config/locales/en.yml

@@ -2,4 +2,6 @@
 # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
 
 en:
-  hello: "Hello world"
+  site:
+    index:
+      header: "The Header"