rubber_ring 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88606257795d525c304fb51c0de3258d45ce6ca4
-  data.tar.gz: 2773526a3a7b38057234d4f16d2cde9ae78daf26
+  metadata.gz: b3c64471e982f5209557aea7e349ffdc4b93d26c
+  data.tar.gz: a3e1c09b8a1c4a11bc3a36807238705d2f0981aa
 SHA512:
-  metadata.gz: 91bf112d4a2096c3375dc916b992c2cb5b7777fdab4e051828d2e5b2bad16e7bf3884324757880a18017d1ab08934927c5d51d4a33b10095f280c952f2e426c7
-  data.tar.gz: 7ac55ed4a603933c48fac098285a72532244db607b761db8b5586edaf4fb2aeb6048b757559ff53962f56ae503c5be5a208f2ef2c580011c6474192daf1bf6fd
+  metadata.gz: e755bb6188026a4a4ea6a52a9e72aa1d12c776f160b4b423b909f6f757887c97543ba26671e9961254337744d1ee1af3020036337649b1f92b2d4e72cd5fc0d3
+  data.tar.gz: 0dcd630fdb4b198703941b3ca76e8a1ba3d080dd7721dc7c38e060ff86e28e491ad3e3f267c82aa220ae1b4c5186cbe90795cc9db6caba1fe0a3a76bd9ea772d

data/README.md

@@ -24,13 +24,13 @@ change fonts and text style
 
 ## Software prerequisites
 
-* Ruby `2.0.0-p0`
-* Rails `4.0.0.rc1`
+* Ruby 2
+* Rails 4
 * imagemagick
 
 ### Browser support
 
-Firefox and Chrome. IE drag and drop doesn't work for now.
+Firefox, Chrome and Safari.
 
 ## Setup
 
@@ -40,28 +40,22 @@ To install `imagemagick` and `sqlite3` on `Ubuntu`
 	sudo apt-get install imagemagick
 	sudo apt-get install libsqlite3-dev
 
-### Setting up new Rails project
+## Setting up a new project
 
-Add it to your `Gemfile`
+Add this to your `Gemfile`
 
 	gem 'rubber_ring'
 
-Create/migrate database
+Create and migrate database
 
     rake rubber_ring:install:migrations
-    rake db:migrate
+    rake db:create db:migrate
 
 Update `development.rb` to enable caching
 
 	config.action_controller.perform_caching = true
 
-Remove `//= require jquery` and `//= require jquery_ujs` from `application.js` because 
-Rubber Ring is already including jQuery for you.
-
-### Setup config files
-
-Generate initialize settings file for admin and settings for publishing pages 
-on production server
+### Generate config files
 
 	rails generate rubber_ring:install
 
@@ -74,8 +68,7 @@ This will generate
 	5. public/.htaccess
 
 1. Set your production server name and path. You will need SSH access and your public key 
-on server. If you tend to use Rubber Ring as part of web application you can ignore this 
-file.
+on server. If you tend to use Rubber Ring as part of web application, or you don't want/need to publish only static HTML files, you can ignore this file.
 2. Set admin password and application type in `app/config/initializers/rubber_ring.rb`.
 3. `app/views/layouts/rubber_ring/layout.html.erb` is here for you to override it, 
 so you have complete control over your markup.
@@ -88,24 +81,25 @@ generated and synced with production server. To serve them both we need this `.h
 
 ### Static pages or Rails application?
 
-* If you only want to use Rubber Ring to generate static pages, leave
-`RubberRing.static_only = true` intact. This will leave you with options to 
-`preview` and `publish` html pages and other assets to production server. Otherwise set 
+If you only want to use Rubber Ring to generate static pages, leave
+`RubberRing.static_only = true` inside `app/config/initializers/rubber_ring.rb` intact.
+This will leave you with options to `preview` and `publish` html pages and other 
+assets to production server. Otherwise set 
 this option to false.
 
 # Usage
 
 ## As an editor I want to easily edit content on my site
 
-Login (`/rubber_ring`) with password which was set by developer in the install stage.
+Login at URL `/rubber_ring` with password which was set by developer in the install stage.
 
-Editing content is easy as clicking inside green boxes and start editing. 
+Just edit content inside green boxes. 
 Developer sets what content is editable/repeatable/link/multi line...
 
 For changing images click on `Image manager` in the upper menu. 
-Drag and drop the image you need to drop zone. After uploading the image you can drag 
-and drop it on the image you wanted to change. Image will be automatically resized 
-to the size that was set by developer/designer.
+Drag and drop the image(s) you need to drop zone. After uploading the 
+image(s) you can drag and drop them on the image you wanted to change. 
+Image will be automatically re-sized to the size that was set by developer/designer.
 
 ### Build and publish your pages
 
@@ -192,7 +186,7 @@ Each helper needs to specify unique `key`. These are holding values in the datab
 Also each helper needs to include `@page` object as their last parameter. 
 This object holds all the editable content of the page in a hash data structure.
 
-#### already used keys which you must not use
+#### reserved key(s) - don't use them
 
 - `page_title`
 
@@ -219,9 +213,9 @@ This object holds all the editable content of the page in a hash data structure.
 You can use, like in any other Rails application, 
 [sprockets directives](https://github.com/sstephenson/sprockets#the-directive-processor) 
 to include assets to your app. 
-Please remove `//= require jquery` and `//= require jquery_ujs` from `application.js`
-because rubber ring is already including `jquery` which you can reuse in your 
-pages as well.
+Please don't use `//= require jquery` and `//= require jquery-ui` 
+in your `application.js` file, because rubber ring is already including `jquery` 
+which you can reuse in your pages as well.
 
 ## Philosophy
 
@@ -229,7 +223,7 @@ pages as well.
 * you can not build robust system without limitations
 * system may stretch only to certain point until it breaks. Like a rubber ring!
 
-## Inspired by
+## Inspired by (aka ideas stolen from)
 
 - [Mercury Editor](http://jejacks0n.github.io/mercury/)
 - [Raptor Editor](http://www.raptor-editor.com/)

data/lib/rubber_ring/version.rb

@@ -1,3 +1,3 @@
 module RubberRing
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/javascripts/fixtures/duplicate_fields.html

@@ -1,2 +1,2 @@
-<a contenteditable="true" data-cms="link" href="/link">Link</a>
-<a contenteditable="true" data-cms="link" href="/link">Link</a>
+<a contenteditable="true" data-cms="link" href="/link">Link</a>
+<a contenteditable="true" data-cms="link" href="/link">Link</a>

data/spec/javascripts/fixtures/editable_fields.html

@@ -1,26 +1,26 @@
-<li class="alert-saved">
-    <div class="alert alert-success">Saved!</div>
-</li>
-
-<h1 contenteditable="true" data-cms="header">
-
-    Test content<p>Paragraph</p>
-    
-    <button class="reset-content"></button>
-    <button class="reset-content"></button>
-</h1>
-
-<a contenteditable="true" data-cms="link" href="/link">
-    Link
-    <button class="reset-content"></button>
-</a>
-
-<img class="rubber_ring_image" data-cms="image"
-     height="360" width="120" src="/assets/baws.jpg">
-
-<a class="rubber_ring_attachment" contenteditable="true"
-   data-cms="attachment_key"
-   href="http://www.example.com/file.pdf">
-  Link to Attachment
-  <button class="reset-content"></button>
-</a>
+<li class="alert-saved">
+    <div class="alert alert-success">Saved!</div>
+</li>
+
+<h1 contenteditable="true" data-cms="header">
+
+    Test content<p>Paragraph</p>
+    
+    <button class="reset-content"></button>
+    <button class="reset-content"></button>
+</h1>
+
+<a contenteditable="true" data-cms="link" href="/link">
+    Link
+    <button class="reset-content"></button>
+</a>
+
+<img class="rubber_ring_image" data-cms="image"
+     height="360" width="120" src="/assets/baws.jpg">
+
+<a class="rubber_ring_attachment" contenteditable="true"
+   data-cms="attachment_key"
+   href="http://www.example.com/file.pdf">
+  Link to Attachment
+  <button class="reset-content"></button>
+</a>

data/spec/javascripts/fixtures/templates.html

@@ -1,21 +1,21 @@
-<div class="templates" data-cms="template_key_1">
-  <article class="t-article" data-template-index="0" data-template="article">
-    <h2 contenteditable="true" data-cms="0_template_key_1_article_title">
-      Article Title
-    </h2>
-    <p contenteditable="true" data-cms="0_template_key_1_article_paragraph">
-      Article content
-    </p>
-  </article>
-  <div data-template-index="1" data-template="blog_post">
-    I'm just a tiny little blog post.
-  </div>
-</div>
-
-<div class="templates" data-cms="template_key_2">
-  <article class="t-article" data-template-index="0" data-template="article">
-    <h2 contenteditable="true" data-cms="0_template_key_2_article_title">
-      Article Title
-    </h2>
-  </article>
-</div>
+<div class="templates" data-cms="template_key_1">
+  <article class="t-article" data-template-index="0" data-template="article">
+    <h2 contenteditable="true" data-cms="0_template_key_1_article_title">
+      Article Title
+    </h2>
+    <p contenteditable="true" data-cms="0_template_key_1_article_paragraph">
+      Article content
+    </p>
+  </article>
+  <div data-template-index="1" data-template="blog_post">
+    I'm just a tiny little blog post.
+  </div>
+</div>
+
+<div class="templates" data-cms="template_key_2">
+  <article class="t-article" data-template-index="0" data-template="article">
+    <h2 contenteditable="true" data-cms="0_template_key_2_article_title">
+      Article Title
+    </h2>
+  </article>
+</div>

data/spec/javascripts/util_spec.coffee

@@ -1,13 +1,13 @@
-describe 'Util', ->
-
-  it 'should not find duplicates', ->
-    loadFixtures('editable_fields.html')
-    util = new Util()
-    duplicates = util.find_duplicated_keys($('[data-cms]'))
-    expect(duplicates.length).toBe(0)
-
-  it 'should find duplicates', ->
-    loadFixtures('duplicate_fields.html')
-    util = new Util()
-    duplicates = util.find_duplicated_keys($('[data-cms]'))
-    expect(duplicates.length).toBe(1)
+describe 'Util', ->
+
+  it 'should not find duplicates', ->
+    loadFixtures('editable_fields.html')
+    util = new Util()
+    duplicates = util.find_duplicated_keys($('[data-cms]'))
+    expect(duplicates.length).toBe(0)
+
+  it 'should find duplicates', ->
+    loadFixtures('duplicate_fields.html')
+    util = new Util()
+    duplicates = util.find_duplicated_keys($('[data-cms]'))
+    expect(duplicates.length).toBe(1)