bizarroids_slider 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2160767c527239ed5874415dcece8deb7e13364f
+  data.tar.gz: e87a273adfa8f63fd2981b3c9a729a01096efe6f
+SHA512:
+  metadata.gz: 4815ed3073aecb0c2099ea6bf36f428985105737dd18547ef768459473b741187fe59ed215b1613fe9ea8c5217999f8c5f72e0a8372bf7dde886f3d5dfa6f7ea
+  data.tar.gz: b8a7ad4bba83eeb09e440799e3939d8146d6144dd6e8cc9ca3647f593eceba274ac4681ce79ce334a1a18da11046152d60b16f1de907674a988c7e4ac1106d73

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,57 @@
+= Bizarroids Slider
+
+Bizarroids Slider provides user managable collections of images Rails application. This is a part of The Bizarroids.
+
+== Installation
+
+Add it to your Gemfile:
+
+  gem 'bizarroids_slider'
+
+Run the following command to install it:
+
+  bundle install
+
+Run the generator:
+
+  rails generate bizarroids:slider:install
+
+== Configuraton
+
+Edit +config/initialisers/bizarroids_slider.rb+. You can create collections using folowing syntax:
+
+  config.collections :key, some: :options
+
+Avaliable options are:
+
+- slide_attributes: [:name, :description, :media, :link] - (default) you can add columns in migration to use them in this case. Pleas do not remove default columns from database to avoid errors.
+- slide_require_attributes: [:name, :media] (default) - make attribute required (only default attributes can be marked as required)
+- versions: { main: {}, thumb: {} } - config of carrierwave image versions. (See corresponging carrierwave documentation)
+
+Some aditional options can be found in application in +config/initialisers/bizarroids_slider.rb+
+
+== Usage
+
+Link to admin panel
+
+  bizarroids_slider_menu_link
+
+If you use cancancan place in your ability.rb somthing like
+
+  can :manage, Bizarroids::Slider::Option
+
+if don't, place in +config/initialisers/bizarroids_slider.rb+
+
+  config.use_cancancan = false
+
+To get collection for :key
+
+  Bizarroids::Slider.get(:key)
+  Bizarroids::Slider[:key]
+
+Slider provides several helpers
+
+bizarroids_slider_slides key - returns collection of slides
+bizarroids_slider_each_slide key - accepts block to iterate
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BizarroidsSlider'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/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

data/app/controllers/bizarroids/slider/application_controller.rb

@@ -0,0 +1,4 @@
+module Bizarroids::Slider
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/bizarroids/slider/collections_controller.rb

@@ -0,0 +1,13 @@
+module Bizarroids::Slider
+  class CollectionsController < parent_controller.constantize
+    respond_to :html
+
+    if Bizarroids::Slider.use_cancancan
+      authorize_resource class: "Bizarroids::Slider::Collection", param_method: :permitted_params
+    end
+
+    def index
+      @collections = Collection.actual
+    end
+  end
+end

data/app/controllers/bizarroids/slider/slides_controller.rb

@@ -0,0 +1,76 @@
+module Bizarroids::Slider
+  class SlidesController < parent_controller.constantize
+    respond_to :html
+    before_action :set_collection, only: %i(index new create)
+    before_action :set_slide, only: %i(edit update destroy up down)
+
+    if Bizarroids::Slider.use_cancancan
+      authorize_resource class: "Bizarroids::Slider::Slide", param_method: :slide_params
+    end
+
+    def index
+      @slides = @collection.slides
+    end
+
+    def new
+      @slide = @collection.slides.build
+    end
+
+    def create
+      # remove media from params to hack carrierwave bug
+      @slide = @collection.slides.build slide_params.except(:media)
+      @slide.media = slide_params[:media]
+
+      if @slide.save
+        redirect_to_collection t('bizarroids.slide.slide_created')
+      else
+        render :new
+      end
+    end
+
+    def edit
+    end
+
+    def update
+      if @slie.update slide_params
+        redirect_to_collection t('bizarroids.slide.slide_updated')
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      @slide.destroy
+      redirect_to_collection t('bizarroids.slide.slide_destroyed')
+    end
+
+    def up
+      @slide.move_higher
+      redirect_to_collection
+    end
+
+    def down
+      @slide.move_lower
+      redirect_to_collection
+    end
+
+    private
+
+    def set_collection
+      @collection = Collection.find_by! key: params[:collection_id]
+    end
+
+    def set_slide
+      @slide = Slide.find params[:id]
+      @collection = @slide.collection
+    end
+
+    def slide_params
+      params.permit(bizarroids_slider_slide: @collection.slide_attributes)[:bizarroids_slider_slide]
+    end
+
+    def redirect_to_collection msg=''
+      redirect_to bizarroids_slider_engine.slider_collection_slides_path(@collection), notice: msg
+    end
+  end
+end

data/app/helpers/bizarroids/slider/application_helper.rb

@@ -0,0 +1,67 @@
+module Bizarroids::Slider
+  module ApplicationHelper
+    # TODO extract to gem
+    def bizarroids_t key
+      t key, scope: :bizarroids
+    end
+
+    # TODO extract to gem
+    def bizarroids_edit_button path
+      bizarroids_button path, :pencil
+    end
+
+    # TODO extract to gem
+    def bizarroids_destroy_button path, confirm_message
+      bizarroids_button path, :trash, method: :delete, data: { confirm: confirm_message }
+    end
+
+    # TODO extract to gem
+    def bizarroids_manage_buttons edit_path, destroy_path, destroy_confirm_message
+      safe_join [
+        bizarroids_edit_button(edit_path),
+        bizarroids_destroy_button(destroy_path, destroy_confirm_message)
+      ]
+    end
+
+    # TODO extract to gem
+    def bizarroids_move_buttons up_path, down_path
+      safe_join [
+        bizarroids_button(up_path, :'arrow-up', method: :patch),
+        bizarroids_button(down_path, :'arrow-down', method: :patch)
+      ]
+    end
+
+    def bizarroids_slider_menu_link
+      link_to bizarroids_t('slider.name'),
+        bizarroids_slider_engine.slider_collections_path,
+        class: [bizarroids_slider_menu_link_class, 'list-group-item']
+    end
+
+    def bizarroids_slider_menu_link_class
+      bizarroids_slider_menu_link_active? ? :active : nil
+    end
+
+    def bizarroids_slider_menu_link_active?
+      controller.class.parent == Bizarroids::Slider
+    end
+
+    def bizarroids_slider_slides key
+      Bizarroids::Slider[key]
+    end
+
+    def bizarroids_slider_each_slide key
+      Bizarroids::Slider[key].each do |slide|
+        yield slide
+      end
+    end
+
+    private
+
+    # TODO extract to gem
+    def bizarroids_button path, icon, link_to_attrs={}
+      link_to path, link_to_attrs, class: 'btn btn-link btn-xs text-primary' do
+        content_tag :span, '', class: "glyphicon glyphicon-#{icon}"
+      end
+    end
+  end
+end

data/app/helpers/bizarroids/slider/collections_helper.rb

@@ -0,0 +1,2 @@
+module Bizarroids::Slider::CollectionsHelper
+end

data/app/helpers/bizarroids/slider/slides_helper.rb

@@ -0,0 +1,9 @@
+module Bizarroids::Slider::SlidesHelper
+  def bizarroids_slider_form_submit_path
+    if @slide.new_record?
+      bizarroids_slider_engine.slider_collection_slides_path @collection
+    else
+      bizarroids_slider_engine.slider_slide_path @slide
+    end
+  end
+end

data/app/models/bizarroids/slider/collection.rb

@@ -0,0 +1,38 @@
+class Bizarroids::Slider::Collection < ActiveRecord::Base
+  has_many :slides
+
+  validates :key, presence: true, uniqueness: true
+
+  scope :actual, -> { where key: Bizarroids::Slider.keys }
+  default_scope -> { order :position }
+
+  def to_param
+    key
+  end
+
+  def to_key
+    key.to_sym
+  end
+
+  def version_options
+    config_options.fetch :versions, {}
+  end
+
+  def human_name
+    name || key.humanize
+  end
+
+  def slide_attributes
+    config_options.fetch :slide_attributes, Bizarroids::Slider.slide_attributes
+  end
+
+  def slide_require_attributes
+    config_options.fetch :slide_require_attributes, Bizarroids::Slider.slide_require_attributes
+  end
+
+  private
+
+  def config_options
+    Bizarroids::Slider.collections[to_key]
+  end
+end

data/app/models/bizarroids/slider/slide.rb

@@ -0,0 +1,17 @@
+class Bizarroids::Slider::Slide < ActiveRecord::Base
+  belongs_to :collection
+
+  validates :collection, presence: true
+
+  delegate :version_options, to: :collection
+
+  ( Bizarroids::Slider::DEFAULT_SLIDE_ATTRIBUTES-[:media] ).each do |attr_name|
+    validates attr_name, presence: true, if: "collection.slide_require_attributes.include? :#{attr_name}"
+  end
+
+  acts_as_list scope: :collection
+
+  default_scope -> { order :position }
+
+  mount_uploader :media, Bizarroids::Slider::MediaUploader
+end

data/app/views/bizarroids/slider/collections/index.html.erb

@@ -0,0 +1,23 @@
+<%= content_for :page_header do %>
+  <h1><%= bizarroids_t 'slider.collections' %></h1>
+<% end %>
+
+<table class='table table-bordered table-striped'>
+  <thead>
+    <tr>
+      <th><%= Bizarroids::Slider::Collection.human_attribute_name(:name) %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @collections.each do |collection| %>
+      <tr>
+        <td>
+          <%= link_to collection.human_name, bizarroids_slider_engine.slider_collection_slides_path(collection) %>
+          <% if collection.description.present? %>
+            <br/><small><%= collection.description %></small>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/bizarroids/slider/slides/_form.html.erb

@@ -0,0 +1,11 @@
+<%= simple_form_for @slide, url: bizarroids_slider_form_submit_path,  html: { class: 'form-horizontal' } do |f| %>
+  <% @collection.slide_attributes.each do |attr_name| -%>
+    <%= f.input attr_name, required: @collection.slide_require_attributes.include?(attr_name) %>
+  <% end -%>
+  <div class='form-group'>
+    <div class='col-lg-offset-2 col-lg-10'>
+      <%= f.submit bizarroids_t(:save), class: 'btn btn-primary' %>
+      <%= link_to bizarroids_t(:cancel), bizarroids_slider_engine.slider_collection_slides_path(@collection), class: 'btn btn-link' %>
+    </div>
+  </div>
+<% end -%>

data/app/views/bizarroids/slider/slides/edit.html.erb

@@ -0,0 +1,9 @@
+<%= content_for :page_header do %>
+  <h1>
+    <%= bizarroids_t 'slider.collection' %>
+    <%= @slide.collection.name %>
+    <small><%= bizarroids_t 'slider.edit_slide' %></small>
+  </h1>
+<% end %>
+
+<div class='well'><%= render 'form' %></div>

data/app/views/bizarroids/slider/slides/index.html.erb

@@ -0,0 +1,47 @@
+<%= content_for :page_header do %>
+  <h1>
+    <%= bizarroids_t 'slider.collection' %>
+    <%= @collection.name %>
+  </h1>
+<% end %>
+
+<div class='lead'>
+  <%= link_to bizarroids_t(:'slider.new_slide'), bizarroids_slider_engine.new_slider_collection_slide_path(@collection), class: 'btn btn-success' %>
+</div>
+
+<table class='table table-bordered table-striped'>
+  <thead>
+    <tr>
+      <% @collection.slide_require_attributes.each do |attr_name| %>
+      <th><%= Bizarroids::Slider::Slide.human_attribute_name(attr_name) %></th>
+      <% end %>
+      <th class='col-sm-2'>&nbsp;</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @slides.each do |slide| %>
+      <tr>
+        <% @collection.slide_require_attributes.each do |attr_name| %>
+          <%# TODO link to media %>
+          <td><%= slide.send attr_name %></td>
+        <% end %>
+        <td class='text-right'>
+          <%=
+            bizarroids_move_buttons(
+              bizarroids_slider_engine.up_slider_slide_path(slide),
+              bizarroids_slider_engine.down_slider_slide_path(slide),
+            )
+          %>
+          &nbsp;
+          <%=
+            bizarroids_manage_buttons(
+              bizarroids_slider_engine.edit_slider_slide_path(slide),
+              bizarroids_slider_engine.slider_slide_path(slide),
+              bizarroids_t('slider.confirm_slide_destroy')
+            )
+          %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/bizarroids/slider/slides/new.html.erb

@@ -0,0 +1,9 @@
+<%= content_for :page_header do %>
+  <h1>
+    <%= bizarroids_t 'slider.collection' %>
+    <%= @collection.name %>
+    <small><%= bizarroids_t 'slider.new_slide' %></small>
+  </h1>
+<% end %>
+
+<div class='well'><%= render 'form' %></div>

data/config/routes.rb

@@ -0,0 +1,11 @@
+Bizarroids::Slider::Engine.routes.draw do
+  scope module: :bizarroids do
+    namespace :slider do
+      resources :collections, only: :index, shallow: true do
+        resources :slides, except: [:show] do
+          patch :up, :down, on: :member
+        end
+      end
+    end
+  end
+end

data/lib/bizarroids/slider/config_error.rb

@@ -0,0 +1,2 @@
+class Bizarroids::Slider::ConfigError < StandardError
+end

data/lib/bizarroids/slider/engine.rb

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

data/lib/bizarroids/slider/media_uploader.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+class Bizarroids::Slider::MediaUploader < CarrierWave::Uploader::Base
+  include CarrierWave::MiniMagick
+
+  storage :file
+
+  def store_dir
+    File.join Bizarroids::Slider.files_storage_dir, model.collection.key, model.id.to_s
+  end
+
+  version :main do
+    process process_variant: :main
+  end
+
+  version :thumb do
+    process process_variant: :thumb
+  end
+
+  def extension_white_list
+    Bizarroids::Slider.extension_white_list
+  end
+
+  private
+
+  def process_variant variant_name
+    if model && model.collection && file
+      processors = model.version_options.fetch variant_name, {}
+
+      processors.each do |method, args|
+        self.send method, *args
+      end
+    end
+  end
+end

data/lib/bizarroids/slider/version.rb

@@ -0,0 +1,5 @@
+module Bizarroids
+  module Slider
+    VERSION = "0.1.0"
+  end
+end

data/lib/bizarroids/slider.rb

@@ -0,0 +1,93 @@
+require 'cancancan'
+require 'simple_form'
+require 'acts_as_list'
+require 'mini_magick'
+require 'carrierwave'
+
+require 'bizarroids/slider/engine'
+require 'bizarroids/slider/config_error'
+require 'bizarroids/slider/media_uploader'
+
+module Bizarroids
+  module Slider
+    # name prefix for ActiveRecord
+    def self.table_name_prefix
+      'bizarroids_slider_'
+    end
+
+    DEFAULT_SLIDE_ATTRIBUTES = %i(name description media link).freeze
+
+    def self.get key
+      Collection.actual.find_by!(key: key).slides
+    end
+
+    class << self
+      alias :[] :get
+    end
+
+    mattr_accessor :collections
+    @@collections = {}
+
+    mattr_accessor :keys
+    @@keys = []
+
+    mattr_accessor :slide_attributes
+    @@slide_attributes = %i(name description media link)
+
+    mattr_accessor :slide_require_attributes
+    @@slide_require_attributes = %i(name)
+
+    mattr_accessor :files_storage_dir
+    @@files_storage_dir = 'system/slider/'
+
+    mattr_accessor :extension_white_list
+    @@extension_white_list = %w(jpg jpeg gif png)
+
+    mattr_accessor :parent_controller
+    @@parent_controller = '::ApplicationController'
+
+    mattr_accessor :use_cancancan
+    @@use_cancancan = true
+
+    def self.setup
+      yield self
+    end
+
+    private
+
+    def self.collection key, attrs={}
+      key = key.to_sym
+      attrs = attrs.dup
+
+      if keys.include? key
+        raise ConfigError.new "Collection ':#{key}' already exists"
+      end
+
+      collections[key] = attrs
+      keys << key
+
+      # skip creating if table is not exists
+      return unless ActiveRecord::Base.connection.table_exists? Collection.table_name
+
+      attrs[:position] = keys.index(key)
+
+      collection = Collection.find_by key: key
+
+      if collection.present?
+        collection.update_attributes attrs.slice(*update_attr_names)
+      else
+        collection = Collection.create! attrs.merge(key: key).slice(*valid_attr_names)
+      end
+
+      collection
+    end
+
+    def self.valid_attr_names
+      %i(key name description position)
+    end
+
+    def self.update_attr_names
+      valid_attr_names - %i(key)
+    end
+  end
+end

data/lib/bizarroids.rb

@@ -0,0 +1,4 @@
+require 'bizarroids/slider'
+
+module Bizarroids
+end

data/lib/bizarroids_slider.rb

@@ -0,0 +1 @@
+require "bizarroids/slider"

data/lib/generators/bizarroids/slider/install/USAGE

@@ -0,0 +1,14 @@
+Description:
+    It will create a migration, initializer and locale files
+
+Example:
+    rails generate bizarroids:slider:install
+
+    This will create:
+        db/migrate/create_bizarroids_slider_tables.rb
+        config/initialiser/bizarroids_slider.rb
+        config/locales/bizarroids_slider.en.yml
+        config/locales/bizarroids_slider.ru.yml
+
+    This will add:
+        routes to config/routes.rb

data/lib/generators/bizarroids/slider/install/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators/active_record/migration'
+
+class Bizarroids::Slider::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  include ActiveRecord::Generators::Migration
+
+  def copy_migration
+    migration_template 'migration.rb', 'db/migrate/create_bizarroids_slider_tables.rb'
+  end
+
+  def create_initalizer
+    initializer 'bizarroids_slider.rb', File.read(File.join(self.class.source_root, 'initializer.rb'))
+  end
+
+  def add_route
+    route "mount Bizarroids::Slider::Engine => '/admin'"
+  end
+
+  def copy_translation_files
+    copy_file "bizarroids_slider.en.yml", "config/locales/bizarroids_slider.en.yml"
+    copy_file "bizarroids_slider.ru.yml", "config/locales/bizarroids_slider.ru.yml"
+  end
+end