bootsy 2.0.9 → 2.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0700c9ebccb580e9c29f62368ff77fd0f1653a6f
-  data.tar.gz: b2c537eb973c476363fbd6bf771c8841ba9e3a9b
+  metadata.gz: 341f757582ae4752e60e70660c9a85298bbb60ac
+  data.tar.gz: f3055d92a7ddfd402951c9efbc4e9ca1e215884a
 SHA512:
-  metadata.gz: ace2b6003ce07536e4993dc83a4dfd693b4da7e7ea6abc1987682e5a2cc4603eb7be47cef062b04761c9a82b837aaf7764f9867ad4b11cb3923531e68912da47
-  data.tar.gz: ecddbe09bc4c69e46550e254bab66de1736dec64ba15790ba2b1024f6d63f1411048dcc92a938c395da210d2d28e98eef21be6816473f9c2742e6519882553c9
+  metadata.gz: 3a546638c142a0fd160c1ca11f6b4b6ac645f794adccb945fa9eed46c33240ca3c54f62dcc5265dafc28e56114038371af854ecbb28500f3be541a2f88c0ec27
+  data.tar.gz: f556b554473dd4c2eb28c5ea3b49f72c75723cbebe79798bad031ad861f9ed0f62b4682912dca6b4df7b9386139875dc3ed345deb241b99ac9487c7c6b5d10ff

data/README.md

@@ -24,24 +24,24 @@
 
 ## Installation
 
-1. Add Bootsy to your Gemfile:
+1\. Add Bootsy to your Gemfile:
 ```ruby
 gem 'bootsy'
 ```
 
-2. Run the bundle command to install it:
+2\. Run the bundle command to install it:
 ```console
 bundle install
 ```
 
-3. Run the install generator:
+3\. Run the install generator:
 ```console
 rails generate bootsy:install
 ```
   It will include the javascripts and stylesheets in the assets pipeline,
   create the `bootsy.rb` initializer and add a copy of the english translations.
 
-4. Add and run migrations (if you're using ActiveRecord):
+4\. Add and run migrations (if you're using ActiveRecord):
 ```console
 rake bootsy:install:migrations
 rake db:migrate

data/app/assets/javascripts/bootsy/init.js

@@ -31,6 +31,6 @@ $(function() {
 
   /* Reload Bootsy on page load when using Turbolinks. */
   if (window.Turbolinks) {
-    document.addEventListener('page:load', Bootsy.init);
+    $(document).on('page:load', Bootsy.init);
   }
 });

data/app/assets/stylesheets/bootsy/bootsy.css

@@ -72,51 +72,56 @@
   margin: 0 0 8px 8px;
 }
 
-blockquote {
-  padding: 0 0 0 15px;
+.bootsy blockquote {
+  padding: 10px 20px;
   margin: 0 0 20px;
-  border-left: 5px solid #eeeeee;
+  font-size: 17.5px;
+  border-left: 5px solid #eee;
 }
-
-blockquote p {
+.bootsy blockquote p:last-child,
+.bootsy blockquote ul:last-child,
+.bootsy blockquote ol:last-child {
   margin-bottom: 0;
 }
-
-blockquote small {
+.bootsy blockquote footer,
+.bootsy blockquote small,
+.bootsy blockquote .small {
   display: block;
-  line-height: 20px;
-  color: #999999;
+  font-size: 80%;
+  line-height: 1.42857143;
+  color: #777;
 }
-
-blockquote small:before {
+.bootsy blockquote footer:before,
+.bootsy blockquote small:before,
+.bootsy blockquote .small:before {
   content: '\2014 \00A0';
 }
-
-blockquote.pull-right {
-  float: right;
+.bootsy .blockquote-reverse,
+.bootsy blockquote.pull-right {
   padding-right: 15px;
   padding-left: 0;
-  border-right: 5px solid #eeeeee;
-  border-left: 0;
-}
-
-blockquote.pull-right p,
-blockquote.pull-right small {
   text-align: right;
+  border-right: 5px solid #eee;
+  border-left: 0;
 }
-
-blockquote.pull-right small:before {
+.bootsy .blockquote-reverse footer:before,
+.bootsy blockquote.pull-right footer:before,
+.blockquote-reverse small:before,
+.bootsy blockquote.pull-right small:before,
+.bootsy .blockquote-reverse .small:before,
+.bootsy blockquote.pull-right .small:before {
   content: '';
 }
-
-blockquote.pull-right small:after {
+.bootsy .blockquote-reverse footer:after,
+.bootsy blockquote.pull-right footer:after,
+.bootsy .blockquote-reverse small:after,
+.bootsy blockquote.pull-right small:after,
+.bootsy .blockquote-reverse .small:after,
+.bootsy blockquote.pull-right .small:after {
   content: '\00A0 \2014';
 }
-
-q:before,
-q:after,
-blockquote:before,
-blockquote:after {
+.bootsy blockquote:before,
+.bootsy blockquote:after {
   content: "";
 }
 

data/app/controllers/bootsy/images_controller.rb

@@ -2,65 +2,54 @@ require_dependency 'bootsy/application_controller'
 
 module Bootsy
   class ImagesController < Bootsy::ApplicationController
-    # GET /images
-    # GET /images.json
     def index
       @gallery = find_gallery
       @images = @gallery.images
 
       respond_to do |format|
         format.html # index.html.erb
-        format.json do
-          rendered_images = []
-
-          @images.each do |image|
-            rendered_images << render_to_string(file: 'bootsy/images/_image',
-                                          formats: [:html],
-                                          locals: { image: image })
-          end
-
-          new_image = render_to_string(file: 'bootsy/images/_new',
-                                        formats: [:html],
-                                        locals: { gallery: @gallery, image: @gallery.images.new })
 
-          render json: { images: rendered_images, form: new_image }
+        format.json do
+          render json: {
+            images: @images.map {|image| image_markup(image) },
+            form: new_image_markup(@gallery)
+          }
         end
       end
     end
 
-    # POST /images
-    # POST /images.json
     def create
       @gallery = find_gallery
       @gallery.save! unless @gallery.persisted?
-      @image = Image.new image_params
-      @image.image_gallery_id = @gallery.id
+      @image = @gallery.images.new(image_params)
 
       respond_to do |format|
         if @image.save
-          image_view = render_to_string(file: 'bootsy/images/_image',
-                                        formats: [:html],
-                                        locals: { image: @image })
-
-          new_image = render_to_string(file: 'bootsy/images/_new',
-                                        formats: [:html],
-                                        locals: { gallery: @gallery, image: @gallery.images.new })
-
-          format.json { render json: { image: image_view, form: new_image, gallery_id: @gallery.id } }
+          format.json {
+            render json: {
+              image: image_markup(@image),
+              form: new_image_markup(@gallery),
+              gallery_id: @gallery.id
+            }
+          }
         else
-          format.json { render json: @image.errors, status: :unprocessable_entity }
+          format.json {
+            render json: @image.errors,
+            status: :unprocessable_entity
+          }
         end
       end
     end
 
-    # DELETE /images/1
-    # DELETE /images/1.json
     def destroy
       @image = Image.find(params[:id])
       @image.destroy
 
       respond_to do |format|
-        format.json { render json: { id: params[:id] } }
+        format.json {
+          render json: { id: params[:id] }
+        }
+
         format.html { redirect_to images_url }
       end
     end
@@ -71,6 +60,32 @@ module Bootsy
       ImageGallery.find(params[:image_gallery_id])
     end
 
+    # Private: Returns the String markup to render
+    # an image in the gallery modal.
+    #
+    # image - The `Bootsy::Image` instance that will
+    #         be rendered.
+    def image_markup(image)
+      render_to_string(
+        file: 'bootsy/images/_image',
+        formats: [:html],
+        locals: { image: image }
+      )
+    end
+
+    # Private: Returns the String markup to render
+    # a form to upload a new image in a given gallery.
+    #
+    # gallery - The `Bootsy::ImageGallery` instance which
+    #           the image will be uploaded to.
+    def new_image_markup(gallery)
+      render_to_string(
+        file: 'bootsy/images/_new',
+        formats: [:html],
+        locals: { gallery: gallery, image: gallery.images.new }
+      )
+    end
+
     # Never trust parameters from the scary internet, only allow the white list through.
     def image_params
       params.require(:image).permit(:image_file)

data/lib/bootsy/activerecord/image.rb

@@ -1,4 +1,7 @@
 module Bootsy
+  # Public: Model to reference the actual image stored trough Bootsy.
+  # It contains the CarrierWave uploader and belongs to a
+  # particular image gallery.
   class Image < ActiveRecord::Base
     belongs_to :image_gallery, touch: true
 

data/lib/bootsy/activerecord/image_gallery.rb

@@ -1,8 +1,20 @@
 module Bootsy
+  # Public: A model that groups all images related to a
+  # Bootsy container (also called a resource).
+  #
+  # It is important to note that the relation gallery - resource
+  # is not mandatory due to the need of having galleries
+  # related to unsaved containers. This may lead to creation
+  # of orphan galleries. Because of that, this model includes
+  # the `destroy_orphans` method, that removes all galleries
+  # that do not point to resources older than the given time
+  # limit.
   class ImageGallery < ActiveRecord::Base
     belongs_to :bootsy_resource, polymorphic: true, autosave: false
     has_many :images, dependent: :destroy
 
-    scope :destroy_orphans, ->(time_limit) { where('created_at < ? AND bootsy_resource_id IS NULL', time_limit).destroy_all }
+    scope :destroy_orphans, ->(time_limit) {
+      where('created_at < ? AND bootsy_resource_id IS NULL', time_limit).destroy_all
+    }
   end
 end

data/lib/bootsy/core_ext.rb

@@ -1,2 +1,4 @@
-ActionView::Base.send :include, Bootsy::FormHelper
-ActionView::Helpers::FormBuilder.send :include, Bootsy::FormBuilder
+# Extend and include Bootsy in proper scopes.
+
+ActionView::Base.send(:include, Bootsy::FormHelper)
+ActionView::Helpers::FormBuilder.send(:include, Bootsy::FormBuilder)

data/lib/bootsy/engine.rb

@@ -1,17 +1,18 @@
 module Bootsy
+  # Public: Define and setup Bootsy as a Rails engine.
   class Engine < Rails::Engine
-
     isolate_namespace Bootsy
 
-    config.generators do |g|                                                               
+    config.generators do |g|
       g.test_framework :rspec
       g.integration_tool :rspec
     end
 
     config.to_prepare do
-      ActionController::Base.class_eval do
-        helper Bootsy::ApplicationHelper
-      end
+      ActionController::Base.helper(Bootsy::ApplicationHelper)
+      # Included at ApplicationController to prevent
+      # missing helpers when it is eager loaded.
+      ApplicationController.helper(Bootsy::ApplicationHelper)
     end
 
     config.after_initialize do
@@ -21,9 +22,9 @@ module Bootsy
         orm = :activerecord
       end
 
-
-      case orm
-      when :activerecord
+      # Require Active Record models. Other ORMs must
+      # include their own Bootsy models.
+      if orm == :activerecord
         Dir[File.expand_path('../activerecord/*.rb', __FILE__)].each {|f| require f }
       end
     end

data/lib/bootsy/form_builder.rb

@@ -1,7 +1,18 @@
 module Bootsy
+  # Public: Convenience module to include Bootsy
+  # in `ActionView::Helpers::FormBuilder`.
   module FormBuilder
-    def bootsy_area method, options = {}
-      @template.bootsy_area @object_name, method, objectify_options(options)
+    # Public: Return a textarea element with proper attributes to
+    # be loaded as a WYSIWYG editor.
+    #
+    # method - The Symbol attribute name on the object assigned to the
+    #          form builder that will tailor the editor.
+    #
+    # options - The Hash of options used to enable/disable features of
+    #           the editor (default: {}).
+    #           Available options are:
+    def bootsy_area(method, options = {})
+      @template.bootsy_area(@object_name, method, objectify_options(options))
     end
   end
 end

data/lib/bootsy/form_helper.rb

@@ -1,5 +1,29 @@
 module Bootsy
+  # Public: Module to include Bootsy in `ActionView::Base`.
   module FormHelper
+    # Public: Return a textarea element with proper attributes to
+    # be loaded as a WYSIWYG editor.
+    #
+    # object_name - The String or Symbol identifier of the object assigned
+    #               to the template.
+    #
+    # method      - The Symbol attribute name on the object assigned to the
+    #               form builder that will tailor the editor.
+    #
+    # options     - The Hash of options used to enable/disable features of
+    #               the editor (default: {}):
+    #               :container      - The `Bootsy::Container` instance model that
+    #                                 will be referenced by the editor's image
+    #                                 gallery. Defaults to the object assigned to
+    #                                 the template, if it is a `Container`.
+    #               :uploader       - The Boolean value used to enable/disable the
+    #                                 image upload feature. Default: true, if a
+    #                                 `Container` is found. false otherwise.
+    #               :editor_options - The Hash of options with Boolean values used
+    #                                 to enable/disable features of the editor.
+    #                                 Available options are described in the Bootsy
+    #                                 initializer file (which is the default for
+    #                                 this argument).
     def bootsy_area(object_name, method, options = {})
       container = options[:container] || options[:object]
 

data/lib/bootsy/version.rb

@@ -1,3 +1,3 @@
 module Bootsy
-  VERSION = '2.0.9'
+  VERSION = '2.0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootsy
 version: !ruby/object:Gem::Version
-  version: 2.0.9
+  version: 2.0.10
 platform: ruby
 authors:
 - Volmer Soares
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-17 00:00:00.000000000 Z
+date: 2014-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: carrierwave
   requirement: !ruby/object:Gem::Requirement
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: A beautiful WYSIWYG editor with image uploads for Rails.