rubber_ring 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3c64471e982f5209557aea7e349ffdc4b93d26c
-  data.tar.gz: a3e1c09b8a1c4a11bc3a36807238705d2f0981aa
+  metadata.gz: e375d094f6ea3db88ea287d9a9fd3ee07298910c
+  data.tar.gz: 0250e2d3135d8c55e885054a9db5147120f7854d
 SHA512:
-  metadata.gz: e755bb6188026a4a4ea6a52a9e72aa1d12c776f160b4b423b909f6f757887c97543ba26671e9961254337744d1ee1af3020036337649b1f92b2d4e72cd5fc0d3
-  data.tar.gz: 0dcd630fdb4b198703941b3ca76e8a1ba3d080dd7721dc7c38e060ff86e28e491ad3e3f267c82aa220ae1b4c5186cbe90795cc9db6caba1fe0a3a76bd9ea772d
+  metadata.gz: 528f3abcbd1fe5b1244a9edd7b33f529b3bd28e5e3409a9df603709769f0e4313d7e05c95ed36512b28ec30b9c8f9658eb066a6cbd92f26a65630fb99be8ceef
+  data.tar.gz: ae5ce9b1a95e00cf407aa4549ac4cd9c1edcb39557fed50045c697d4844fca135d741bd61764f50ce4149358158a6e0388c8ab2c9fd062a04725e43b59c660b8

data/README.md

@@ -3,11 +3,11 @@
 
 ## About
 
-This CMS helps you build editable pages fast. You define which content 
-(`text`, `image`, `attachment`, ...) should be editable for your users. 
-Limitation, that only developer sets what page parts are editable is good for 
+This CMS helps you build editable pages fast. You define which content
+(`text`, `image`, `attachment`, ...) should be editable for your users.
+Limitation, that only developer sets what page parts are editable is good for
 keeping the design intact. It is basically backend for saving `contenteditable` content.
-When done editing, only static assets will be published to production server 
+When done editing, only static assets will be published to production server
 where you only need a web server like Apache or Nginx.
 
 Named by The Smiths [song](http://www.youtube.com/watch?v=Cpf6gJU3520).
@@ -19,14 +19,24 @@ Named by The Smiths [song](http://www.youtube.com/watch?v=Cpf6gJU3520).
 - customer doesn't need application server and/or database. Only plain web server for static HTML serving will do
 
 ### This CMS is not good for
-sites, where **editor** wants to create new pages and control each part of every page, 
+sites, where **editor** wants to create new pages and control each part of every page,
 change fonts and text style
 
 ## Software prerequisites
 
 * Ruby 2
 * Rails 4
+* ruby web server running at least 2 processes (puma, unicorn, thin) - I only tested with puma for now
 * imagemagick
+* wget
+
+## Versions
+
+Use `gem 'rubber_ring', '~> 0.1.2'` if you don't want to run multiple processes. Instead you will need to publish each
+change of any page separately.
+
+Use `gem 'rubber_ring', '~> 1.0.0'` if you can have two or more processes of web server. In this version whole site
+will be built in one step.
 
 ### Browser support
 
@@ -36,7 +46,7 @@ Firefox, Chrome and Safari.
 
 ### Dependencies
 To install `imagemagick` and `sqlite3` on `Ubuntu`
-	
+
 	sudo apt-get install imagemagick
 	sudo apt-get install libsqlite3-dev
 
@@ -51,9 +61,11 @@ Create and migrate database
     rake rubber_ring:install:migrations
     rake db:create db:migrate
 
-Update `development.rb` to enable caching
+Update `development.rb` to enable build for development mode. This will disable rails to add `body=1` to every asset link.
 
-	config.action_controller.perform_caching = true
+```ruby
+config.assets.debug = false
+```
 
 ### Generate config files
 
@@ -66,25 +78,37 @@ This will generate
 	3. app/views/layouts/rubber_ring/layout.html.erb
 	4. app/assets/javascripts/application.js
 	5. public/.htaccess
+	6. app/puma.rb
 
-1. Set your production server name and path. You will need SSH access and your public key 
+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, 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, 
+3. `app/views/layouts/rubber_ring/layout.html.erb` is here for you to override it,
 so you have complete control over your markup.
-4. This is copied because default Rails `application.js` includes `jquery` which is 
+4. This is copied because default Rails `application.js` includes `jquery` which is
 already included for you by Rubber Ring (avoiding clashes).
-5. Apaches access config. Including rules so you can access all published pages. It will 
-look for `.html` files first and enter sub directories later. Example: we have page with 
-route `/en` and `/en/example`. When published, `en.html` and `en/example.html` will be 
+5. Apaches access config. Including rules so you can access all published pages. It will
+look for `.html` files first and enter sub directories later. Example: we have page with
+route `/en` and `/en/example`. When published, `en.html` and `en/example.html` will be
 generated and synced with production server. To serve them both we need this `.htaccess` file.
+6. We need to run `Rubber Ring` as `Rails Application` with at least two workers. This is
+because when doing a request to `/rubber_ring/build` there will also run a `wget` program
+which will download all `html` files and save them into `public/build` directory. Without
+more workers we need to must use threads, but with threads we can not accurately tell
+user when `wget` program finishes its job.
+
+### Run
+
+```bash
+puma -p 3000 -C config/puma.rb
+```
 
 ### Static pages or Rails application?
 
 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 will leave you with options to `preview` and `publish` html pages and other
+assets to production server. Otherwise set
 this option to false.
 
 # Usage
@@ -93,17 +117,22 @@ this option to false.
 
 Login at URL `/rubber_ring` with password which was set by developer in the install stage.
 
-Just edit content inside green boxes. 
+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(s) you need to drop zone. After uploading the 
-image(s) you can drag and drop them on the image you wanted to change. 
+For changing images click on `Image manager` in the upper menu.
+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.
 
+### Preview
+
+The easiest way to preview your current work is to log out or even better, open it in
+a new browser where you are not logged in.
+
 ### Build and publish your pages
 
-`Preview` option in the menu will output entire page to `public/build` directory. `Publish` will upload current page to your production server, set in `publish.yml` file.
+`Build & Publish` option in the menu will first output entire page to `public/build` directory. `Publish` will upload/copy whole site to your production server, set in `publish.yml` file.
 
 ## As a developer I want to quickly setup editable pages
 
@@ -131,7 +160,7 @@ Examples
 <% end %>
 
 <%= editable_field(:div, {key: 'first_content', class: 'multi-line'}, @page) do %>
-  I'm editable content in 
+  I'm editable content in
   multi lines...
 <% end %>
 
@@ -155,7 +184,7 @@ Allows you to set up repeating and sortable templates. Example
 %>
 ```
 
-This means, that you need to create new view for each template in 
+This means, that you need to create new view for each template in
 `app/views/templates/`. Example
 
     app/views/templates/_article.html.erb
@@ -170,8 +199,8 @@ means that you need a view, saved in a file
 
     app/views/templates/_article.html.erb
 
-**Inside templates** you can use all other helpers. **BUT**, you need to 
-assemble your key correctly or otherwise you will be overwriting your own content. 
+**Inside templates** you can use all other helpers. **BUT**, you need to
+assemble your key correctly or otherwise you will be overwriting your own content.
 You can use `key_prefix`, which is assembled the way which will help you to prevent key overwites. Example:
 
 ```erb
@@ -182,8 +211,8 @@ You can use `key_prefix`, which is assembled the way which will help you to prev
 
 ### Helper options
 
-Each helper needs to specify unique `key`. These are holding values in the database. 
-Also each helper needs to include `@page` object as their last parameter. 
+Each helper needs to specify unique `key`. These are holding values in the database.
+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.
 
 #### reserved key(s) - don't use them
@@ -210,11 +239,11 @@ This object holds all the editable content of the page in a hash data structure.
 
 ### Assets (stylesheets and javascripts)
 
-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 don't use `//= require jquery` and `//= require jquery-ui` 
-in your `application.js` file, because rubber ring is already including `jquery` 
+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 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

data/app/assets/stylesheets/libs/{bootstrap.scss.erb → bootstrap.scss}

@@ -2285,7 +2285,7 @@ table th[class*="span"],
   *margin-right: .3em;
   line-height: 14px;
   vertical-align: text-top;
-  background-image: url("<%= image_path('glyphicons-halflings.png') %>");
+  background-image: image-url('glyphicons-halflings.png');
   background-position: 14px 14px;
   background-repeat: no-repeat;
 }
@@ -2309,7 +2309,7 @@ table th[class*="span"],
 .dropdown-submenu:focus > a > [class^="icon-"],
 .dropdown-submenu:hover > a > [class*=" icon-"],
 .dropdown-submenu:focus > a > [class*=" icon-"] {
-  background-image: url("<%= image_path('glyphicons-halflings-white.png') %>");
+  background-image: image-url('glyphicons-halflings-white.png');
 }
 
 .icon-glass {

data/app/assets/stylesheets/rubber_ring/cms.scss

@@ -198,3 +198,13 @@
 .tbs [class^="icon-"], .tbs [class*=" icon-"] {
   margin: 3px 0 0 5px;
 }
+
+.tbs .brand a {
+  color: #777777;
+
+  &:hover {
+    color: #333333;
+    text-decoration: none;
+    background-color: transparent;
+  }
+}

data/app/concerns/rubber_ring/build.rb

@@ -1,33 +1,21 @@
 module RubberRing
   module Build
 
-    def Build.assets!
-      # clear old assets and copy new ones
-      build_assets_dir = "#{Rails.root.to_s}/public/build/assets"
-      if File.directory?(build_assets_dir)
-        FileUtils.rm_rf("#{build_assets_dir}/*")
-      else
-        FileUtils.mkdir_p(build_assets_dir)
-      end
+    def Build.run!(request)
+      # wget -m -p -E -k -np http://localhost:3000 -P build -nH
+      # -nH: no host directories
+      # -p: prefix with directory
+      # -E: adjust extension, save as .html
+      # -k: convert links suitable for local viewing
 
-      # if running on production copy assets from precompiled files from public directory
-      prod_assets_dir = "#{Rails.root.to_s}/public/assets"
-      if Rails.env.production? and File.directory?(prod_assets_dir)
-        FileUtils.cp_r("#{prod_assets_dir}/.", build_assets_dir)
-      else
-        %w(images javascripts stylesheets fonts).each do |asset_dir|
-          dir = "#{Rails.root.to_s}/app/assets/#{asset_dir}"
-          if File.directory?(dir)
-            FileUtils.cp_r("#{dir}/.", build_assets_dir)
-          end
-        end
-      end
+      root_url = request.protocol + request.host_with_port
+      build_dir = "#{Rails.root.to_s}/public/build"
 
-      # copy attachments
-      upload_dir = "#{Rails.root.to_s}/public/upload"
-      if File.directory?(upload_dir)
-        FileUtils.cp_r(upload_dir, "#{Rails.root.to_s}/public/build")
-      end
+      # clear previous build
+      FileUtils.rm_rf(build_dir)
+
+      cmd = "wget -m -p -E -k -np #{root_url} -P #{build_dir} -nH"
+      system(cmd)
     end
 
   end

data/app/controllers/rubber_ring/attachments_controller.rb

@@ -12,7 +12,7 @@ module RubberRing
         convert_image(path, width, height) if File.exist?(path)
       end
 
-      expire_and_respond(page)
+      respond(page)
     end
 
     def convert_image(path, width, height)
@@ -22,7 +22,7 @@ module RubberRing
 
     def save_attachment
       page = Util.save_page_content(params)
-      expire_and_respond(page)
+      respond(page)
     end
 
     def add

data/app/controllers/rubber_ring/cms_controller.rb

@@ -9,17 +9,17 @@ module RubberRing
 
     def save
       page = Util.save_page_content(params)
-      expire_and_respond(page)
+      respond(page)
     end
 
     def remove
       page = Page.remove(@options, params[:key])
-      expire_and_respond(page)
+      respond(page)
     end
 
     def save_template
       page = Page.save_or_update_templates(@options)
-      expire_and_respond(page)
+      respond(page)
     end
 
     def add_template
@@ -38,13 +38,12 @@ module RubberRing
 
       response = view_context.content_tag(new_pt.element, view_context.raw(template), content_tag_options)
 
-      expire_page(params[:page_path])
       render :json => {new_template: response}
     end
 
     def remove_template
       page = Page.remove_template(@options)
-      expire_and_respond(page)
+      respond(page)
     end
 
   private

data/app/controllers/rubber_ring/rubber_ring_controller.rb

@@ -3,7 +3,7 @@ module RubberRing
     layout 'rubber_ring/layout'
 
     before_action :load_page_content, :set_locale
-    before_filter :admin?, :cache?, :publish? # check if admin before cache
+    before_filter :admin?
 
     def load_page_content
       page = Page.where(
@@ -17,13 +17,34 @@ module RubberRing
       @images, @attachments = Util.load_attachments_page(params)
     end
 
+    def build
+      # when running with puma and multiple workers this is the best option
+      Build.run!(request)
+
+      # when running with single process server, new thread needs to be spawn
+      # downside of this option is, that we can not know when build is completed
+
+      #Thread::new{
+      #  Build.run!(request)
+      #}
+    end
+
+    def publish
+      begin
+        Publish.assets!
+      rescue Errno::EACCES
+        flash.now[:error] =
+          'Rubber Ring is trying to copy files on to path which is not writable.
+           Please tell developers to check publish.yml file.'
+      end
+    end
+
     def set_locale
       I18n.locale = params[:locale] || I18n.default_locale
       @locale = I18n.locale.to_s
     end
 
-    def expire_and_respond(page)
-      expire_page(params[:page_path])
+    def respond(page)
       render :json => {controller: page.controller, action: page.action, content: page.content}
     end
 
@@ -38,30 +59,5 @@ module RubberRing
           @page.edit_mode = false
         end
       end
-
-      def cache?
-        if params[:cache] == '1' and params[:publish].nil?
-          disable_edit_mode
-          Thread::new{
-            Build.assets!
-          }
-        end
-      end
-
-      def publish?
-        if params[:publish] == '1' and params[:cache] == '1'
-          disable_edit_mode
-          Thread::new{
-            Build.assets!
-            Publish.assets!
-          }
-        end
-      end
-
-      def disable_edit_mode
-        @page_caching = true
-        @page.edit_mode = false
-      end
-
   end
 end

data/app/controllers/rubber_ring/sessions_controller.rb

@@ -13,7 +13,7 @@ module RubberRing
         session[:password] = params[:password]
         redirect_to main_app.root_path
       else
-        flash[:wrong_password] = 'Wrong password'
+        flash.now[:error] = 'Wrong password'
         render :new
       end
     end

data/app/views/layouts/rubber_ring/sessions.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rubber Ring Login</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <%= stylesheet_link_tag 'rubber_ring/application', media: 'all' %>
+</head>
+<body>
+  <div class="tbs">
+    <%= yield %>
+  </div>
+</body>
+</html>

data/app/views/rubber_ring/_application.html.erb

@@ -2,7 +2,9 @@
   <div class="tbs" id="rubber-ring-application">
     <div class="navbar">
       <div class="navbar-inner">
-        <span class="brand">Rubber Ring</span>
+        <span class="brand">
+          <a href="/">Rubber Ring</a>
+        </span>
         <ul class="nav">
           <li>
             <a class="dropdown" id="attachment-manager" href="javascript:void(0);">Attachments</a>
@@ -12,10 +14,7 @@
           </li>
           <% if RubberRing.static_only %>
             <li>
-              <a href="?cache=1" target="_blank">Preview</a>
-            </li>
-            <li>
-              <a href="?cache=1&publish=1" target="_blank">Publish</a>
+              <%= link_to 'Build & Publish', rubber_ring.build_path %>
             </li>
           <% end %>
           <li class="alert-saved">
@@ -24,7 +23,7 @@
         </ul>
         <ul class="nav pull-right">
           <li>
-            <a href="<%= rubber_ring.logout_path %>">Logout</a>
+            <%= link_to 'Logout', rubber_ring.logout_path %>
           </li>
         </ul>
       </div>