copy 0.0.41 → 0.1.0

data/README.md

@@ -1,8 +1,67 @@
-## Copy is a sinatra-based content management system.
+# Copy is a simple, Sinatra-based content management system.
 
-Copy is similar to [Brochure](https://github.com/sstephenson/brochure) in spirit, but with the addition of editable text blocks.
+`$ gem install copy` and then generate a new site `$ copy -n mynewsite`
 
-More soon.
+    mynewsite/
+    ├── Gemfile              <- Uncomment the gems you need for storage.
+    ├── config.ru            <- Configure storage, user, and password here.
+    ├── public               <- The public root of your new site.
+    │   ├── favicon.ico         Ships with a few helpful defaults.
+    │   ├── images
+    │   ├── javascripts
+    │   │   └── main.js
+    │   ├── robots.txt
+    │   └── stylesheets
+    │       └── main.css
+    └── views                <- Your views, layouts, and partials live here.
+        ├── index.html.erb
+        └── layout.html.erb
+        
+The layout (`layout.html.erb`) yields to all the views. It's not required so delete it if your views contain full html documents.
+
+Copy automatically maps URLs to files in your `views` directory.
+
+* `/` &rarr; `index.html.erb`
+* `/about` &rarr; `about.html.erb` or `about/index.html.erb`
+* `/about/us` &rarr; `about/us.html.erb`
+
+Copy lets you define blocks of editable text in your views.
+
+    <% copy :contact do %>
+      1 _Infinite_ Loop
+      Cupertino, CA 95014
+      408.996.1010
+    <% end %>
+
+The text provided in the block will be saved and can then be edited live on the site. All content is formatted with Markdown. [See demo](http://copy-demo.heroku.com) for a live example or [view the source](https://github.com/javan/copy-demo).
+
+Single line blocks will be edited in a text field as opposed to a textarea. Perfect for headlines.
+
+    <h1><% copy :title %>Like a boss!<% end %></h1>
+
+**Partials** can be rendered from any view with the `partial` helper. Their filenames are always prefixed with an underscore.
+
+* `<%= partial 'nav' %>` renders `_nav.html.erb`
+* `<%= partial 'shared/details' %>` renders `shared/_details.html.erb`
+
+----
+
+### Storage
+
+Copy supports multiple backends for storage: redis, mongodb, mysql, postgres, and sqlite.
+
+Choosing and configuring your storage option is done in one line in your `config.ru` file by providing a connection URI.
+
+Examples:
+
+* `set :storage, 'mongodb://user:pass@host:port/database'`
+* `set :storage, 'postgres://user:pass@host/database'`
+
+----
+
+### Editing copy on your live site
+
+Browse to `/_copy` and drag the "Edit Copy" link to your bookmarks bar. Return to your site, click the bookmark (you'll be prompted for your username and password) and then click on the highlighted text to edit it. That's it!
 
 ----
 

data/copy.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Javan Makhmali"]
   s.email       = ["javan@javan.us"]
-  s.homepage    = ""
-  s.summary     = %q{Tiny CMS built with Sinatra}
-  s.description = %q{Serve mostly static pages with blocks of client-editable text.}
+  s.homepage    = "https://github.com/javan/copy"
+  s.summary     = %q{Simple, Sinatra-based CMS.}
+  s.description = %q{Serves mostly static pages with blocks of editable copy.}
 
   s.rubyforge_project = "copy"
   

data/lib/copy/admin/copy.css

@@ -48,9 +48,13 @@
   text-decoration: underline;
 }
 
-#_copy textarea {
+#_copy textarea,
+#_copy input[type="text"] {
   font-size: 13px;
-  height: 300px;
   width: 490px;
   padding: 5px;
+}
+
+#_copy textarea { 
+  height: 300px;
 }

data/lib/copy/admin/edit.html.erb

@@ -1,6 +1,10 @@
 <div id="_copy">
   <form class="_copy_edit_form" data-content-name="<%= @name %>" action="/_copy/<%= @name %>">
-    <textarea name="content"><%= @doc %></textarea>
+    <% if @doc =~ /\n/  %>
+      <textarea name="content"><%=h @doc %></textarea>
+    <% else %>
+      <input type="text" name="content" value="<%=h @doc %>" />
+    <% end %>
     <p class="_copy_footer _copy_footer_left">
       <input class="_copy_submit" type="submit" value="Save" />
       or <a class="_copy_cancel" href="#">cancel</a>

data/lib/copy/admin/index.js.erb

@@ -31,7 +31,7 @@ jQuery.noConflict();
         success: function(html) {
           $('body').prepend(html);
           $('#_copy').css({ margin:'-'+($('#_copy').height() / 2)+'px 0 0 -'+($('#_copy').width() / 2)+'px' });
-          $('#_copy textarea').get(0).focus();
+          $('#_copy [name="content"]').get(0).focus();
         }
       });
     });
@@ -39,6 +39,7 @@ jQuery.noConflict();
     $('._copy_cancel').live('click', function() {
       $('#_copy').remove();
       clickable();
+      return false;
     });
     
     $('._copy_edit_form').live('submit', function() {
@@ -48,7 +49,7 @@ jQuery.noConflict();
       $.ajax({
         type: 'PUT',
         url: form.attr('action'),
-        data: { content: form.find('textarea').val(), wrap_tag: original.get(0).tagName.toLowerCase() },
+        data: { content: form.find('[name="content"]').val(), wrap_tag: original.get(0).tagName.toLowerCase() },
         success: function(html) {
           $('#_copy').remove();
           original.replaceWith(html);

data/lib/copy/generators/site/config.ru

@@ -1,9 +1,6 @@
-begin
-  require 'copy'
-rescue LoadError
-  require 'rubygems'
-  require 'copy'
-end
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
 
 Copy::Server.config do
   # Sets a Cache-Control header for the duration specified.
@@ -20,6 +17,7 @@ Copy::Server.config do
   # set :copy_password, ENV['COPY_PASSWORD']
   
   # Enter the URL to your data store.
+  # Be sure to uncomment the correlating gems in your Gemfile.
   # "redis://", "mongodb://", "mysql://", "postgres://", and "sqlite://" are supported.
   # Heroku friendly: http://devcenter.heroku.com/articles/mongohq
   #

data/lib/copy/generators/site/views/layout.html.erb

@@ -4,9 +4,11 @@
   <meta charset="utf-8"> 
   <title>I love Copy</title> 
   <link rel="stylesheet" href="/stylesheets/main.css">
-  <script src="/javascripts/main.js"></script>
 </head> 
 <body>
+  
   <%= yield %>
+  
+  <script src="/javascripts/main.js"></script>
 </body> 
 </html>

data/lib/copy/server.rb

@@ -9,6 +9,9 @@ module Copy
     set :root, File.dirname(File.expand_path(__FILE__))
     
     helpers do
+      include Rack::Utils
+      alias_method :h, :escape_html
+        
       def protected!
         unless authorized?
           response['WWW-Authenticate'] = %(Basic realm="Copy Admin Area")
@@ -68,6 +71,12 @@ module Copy
         # Append the output buffer.
         @_out_buf << format_text(name, content, options)
       end
+      
+      def partial(template)
+        template_array = template.to_s.split('/')
+        template = template_array[0..-2].join('/') + "/_#{template_array[-1]}.#{@_route.format}"
+        send(@_route.renderer, template.to_sym, :layout => false)
+      end
     end
     
     def self.config(&block)
@@ -105,11 +114,11 @@ module Copy
     end
     
     get '*' do
-      route = Copy::Router.new(params[:splat].first, settings.views)
-      if route.success?
+      @_route = Copy::Router.new(params[:splat].first, settings.views)
+      if @_route.success?
         set_cache_control_header
-        content_type(route.format)
-        send(route.renderer, route.template, :layout => route.layout)
+        content_type(@_route.format)
+        send(@_route.renderer, @_route.template, :layout => @_route.layout)
       else
         not_found
       end

data/lib/copy/storage/mongodb.rb

@@ -1,4 +1,3 @@
-require 'mongo'
 require 'uri'
 
 module Copy

data/lib/copy/storage/redis.rb

@@ -1,5 +1,3 @@
-require 'redis'
-
 module Copy
   module Storage
     class Redis
@@ -16,4 +14,4 @@ module Copy
       end
     end
   end
-end
+end

data/lib/copy/storage/relational.rb

@@ -1,5 +1,3 @@
-require 'data_mapper'
-
 module Copy
   module Storage
     class Relational

data/lib/copy/version.rb

@@ -1,3 +1,3 @@
 module Copy
-  VERSION = '0.0.41'
+  VERSION = '0.1.0'
 end

data/test/server_test.rb

@@ -112,6 +112,12 @@ class ServerCopyHelperTest < Test::Unit::TestCase
     assert last_response.ok?
     assert_match %Q(<span class="_copy_editable" data-name="headline">Important!</span>), last_response.body
   end
+  
+  test "partial rendering" do
+    get 'renders_partials'
+    assert last_response.ok?, last_response.errors
+    assert_match "before\none\ntwo\nthree\nafter", last_response.body
+  end
 end
 
 class ServerAdminTest < Test::Unit::TestCase
@@ -146,12 +152,18 @@ class ServerAdminTest < Test::Unit::TestCase
   
   test "GET /_copy/:name" do
     Copy::Storage.stubs(:connected?).returns(true)
-    Copy::Storage.expects(:get).with('fun').returns('party')
+    Copy::Storage.expects(:get).with('fun').returns('"party"')
     
     authorize!
     get '/_copy/fun'
     assert last_response.ok?, last_response.errors
-    assert_match "party</textarea>", last_response.body
+    # Single line content renders in a text field
+    assert_match 'value="&quot;party&quot;"', last_response.body
+    
+    # Multiline renders in a textarea
+    Copy::Storage.expects(:get).with('fun').returns("<b>party\n")
+    get '/_copy/fun'
+    assert_match "&lt;b&gt;party\n</textarea>", last_response.body
   end
   
   test "PUT /_copy/:name" do

data/test/test_app/views/_one.html.erb

@@ -0,0 +1 @@
+one

data/test/test_app/views/_three.html.erb

@@ -0,0 +1 @@
+three

data/test/test_app/views/about/_two.html.erb

@@ -0,0 +1,2 @@
+two
+<%= partial :three %>

data/test/test_app/views/renders_partials.html.erb

@@ -0,0 +1,4 @@
+before
+<%= partial 'one' %>
+<%= partial 'about/two' %>
+after

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: copy
 version: !ruby/object:Gem::Version 
-  hash: 77
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 41
-  version: 0.0.41
+  version: 0.1.0
 platform: ruby
 authors: 
 - Javan Makhmali
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-15 00:00:00 -04:00
+date: 2011-05-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,7 +62,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: Serve mostly static pages with blocks of client-editable text.
+description: Serves mostly static pages with blocks of editable copy.
 email: 
 - javan@javan.us
 executables: 
@@ -106,17 +106,21 @@ files:
 - test/router_test.rb
 - test/server_test.rb
 - test/storage_test.rb
+- test/test_app/views/_one.html.erb
+- test/test_app/views/_three.html.erb
+- test/test_app/views/about/_two.html.erb
 - test/test_app/views/about/index.html.erb
 - test/test_app/views/about/us.html.erb
 - test/test_app/views/data/people.csv.erb
 - test/test_app/views/data/people.xml.erb
 - test/test_app/views/index.html.erb
 - test/test_app/views/layout.html.erb
+- test/test_app/views/renders_partials.html.erb
 - test/test_app/views/with_copy_helper.html.erb
 - test/test_app/views/with_copy_helper_one_line.html.erb
 - test/test_helper.rb
 has_rdoc: true
-homepage: ""
+homepage: https://github.com/javan/copy
 licenses: []
 
 post_install_message: 
@@ -148,17 +152,21 @@ rubyforge_project: copy
 rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: Tiny CMS built with Sinatra
+summary: Simple, Sinatra-based CMS.
 test_files: 
 - test/router_test.rb
 - test/server_test.rb
 - test/storage_test.rb
+- test/test_app/views/_one.html.erb
+- test/test_app/views/_three.html.erb
+- test/test_app/views/about/_two.html.erb
 - test/test_app/views/about/index.html.erb
 - test/test_app/views/about/us.html.erb
 - test/test_app/views/data/people.csv.erb
 - test/test_app/views/data/people.xml.erb
 - test/test_app/views/index.html.erb
 - test/test_app/views/layout.html.erb
+- test/test_app/views/renders_partials.html.erb
 - test/test_app/views/with_copy_helper.html.erb
 - test/test_app/views/with_copy_helper_one_line.html.erb
 - test/test_helper.rb