admin_bits 0.4.0

data/lib/admin_bits/base_config.rb

@@ -0,0 +1,38 @@
+module AdminBits
+  class BaseConfig
+    def initialize
+      @options = {}.with_indifferent_access
+    end
+
+    def [](name)
+      @options[name]
+    end
+
+    def self.rw_method(name)
+      define_method name do |value = nil, &block|
+        throw_error if block && value
+        @options[name] = value || block
+      end
+
+      define_method "get_#{name}" do
+        @options[name]
+      end
+    end
+
+    def inspect
+      @options.inspect
+    end
+
+    rw_method :path
+    rw_method :filters
+    rw_method :ordering
+    rw_method :default_order
+    rw_method :default_direction
+    rw_method :layout # :off | :default | "layout_name"
+    rw_method :mods # [BasicAdminPanel]
+  private
+    def throw_error
+      raise "Please provide either block of value"
+    end
+  end
+end

data/lib/admin_bits/engine.rb

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

data/lib/admin_bits/helpers.rb

@@ -0,0 +1,44 @@
+module AdminBits
+  module Helpers
+    def admin_link(attrib, name)
+      link_content = name.html_safe
+
+      if admin_resource.request_params[:order] == attrib.to_s
+        ascending = admin_resource.request_params[:asc] == "true" ? true : false
+        klass = ascending ? "sort_asc" : "sort_desc"
+        ascending = !ascending
+      else
+        klass = nil
+        ascending = true
+      end
+
+      link_to link_content, admin_resource.url(:order => attrib, :asc => ascending.to_s), :class => klass
+    end
+
+    def admin_form(options = {}, &block)
+      form_tag(admin_resource.original_url, options) do
+        content = capture(&block)
+
+        tags = [
+          hidden_field_tag("order", admin_resource.request_params[:order]),
+          hidden_field_tag("asc", admin_resource.request_params[:asc]),
+          content
+        ]
+
+        tags.join("").html_safe
+      end
+    end
+
+    def admin_select_filter(attribute, options, html_options)
+      select_tag "filters[#{attribute}]", options, html_options
+    end
+
+    def admin_text_filter(attribute)
+      text_field_tag "filters[#{attribute}]", admin_resource.filter_params[attribute]
+    end
+
+    def admin_date_filter(attribute)
+      text_field_tag "filters[#{attribute}]", admin_resource.filter_params[attribute], :class => "datepicker"
+    end
+  end
+end

data/lib/admin_bits/scopes.rb

@@ -0,0 +1,52 @@
+module AdminBits
+  module Scopes
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def admin_extension_scopes
+        @@admin_extension_scopes || {}
+      end
+
+      def declare_time_range_scope(name, options = {})
+        @@admin_extension_scopes ||= {}
+        @@admin_extension_scopes[name] = :time_range
+
+        scope name, ->(date_from, date_to) do
+          column = options.fetch(:on)
+          date_from = Time.parse(date_from) rescue nil
+          date_to   = Time.parse(date_to) rescue nil
+
+          result_scope = where(nil)
+
+          if date_from
+            result_scope = result_scope.where(arel_table[column].gteq(date_from))
+          end
+
+          if date_to
+            result_scope = result_scope.where(arel_table[column].lteq(date_to))
+          end
+
+          result_scope
+        end
+      end
+
+      def declare_text_search_scope(name, options = {})
+        @@admin_extension_scopes ||= {}
+        @@admin_extension_scopes[name] = :text
+
+        scope name, ->(text) do
+          if text.present?
+            columns = options.fetch(:on)
+            where(AdminExtension::Utils.create_search_conditions(text, columns))
+          else
+            where(nil)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/admin_bits/utils.rb

@@ -0,0 +1,16 @@
+module AdminBits
+  class Utils
+    def self.split_text(text)
+      text.strip.split(/\s+/)
+    end
+
+    # Returns array of confitions for text search
+    def self.create_search_conditions(text, columns)
+      text = split_text(text).join("%")
+      text = "%" + text + "%"
+      conditions = [columns.map {|c| "#{c} LIKE ?"}.join(" OR ")]
+      columns.length.times { conditions << text }
+      conditions
+    end
+  end
+end

data/lib/generators/admin_bits_generator.rb

@@ -0,0 +1,52 @@
+require 'rails/generators'
+require 'rbconfig'
+
+class AdminBitsGenerator < Rails::Generators::Base
+
+  class_option :layout,
+    :type => :string,
+    :desc => "Name of the generated layout eg. 'admin' will be placed in 'app/views/layouts/admin.html.erb'",
+    :aliases => '-L', :default => 'admin'
+  class_option :namespace,
+    :type => :string,
+    :desc => "Name of the namespace for the generated controller eg. 'admin'",
+    :aliases => '-NS', :default => 'admin'
+  class_option :resource,
+    :type => :string,
+    :required => true,
+    :desc => "Name of the resource eg. 'products' will create 'namespace/products_controller.rb'",
+    :aliases => '-R'
+  class_option :unify, # TODO
+    :type => :boolean,
+    :default => false,
+    :desc => "Create special BaseController in the selected namespace",
+    :aliases => '-U'
+
+  self.source_paths << File.join(File.dirname(__FILE__), 'templates')
+
+  def create_layout
+    template "layout.html.erb", "app/views/layouts/#{ layout }.html.erb"
+  end
+
+  def create_controller
+    template "controller.rb.erb", "app/controllers/#{ namespace }/#{ resource }_controller.rb"
+  end
+
+  protected
+
+  def layout
+    options[:layout]
+  end
+
+  def namespace
+    options[:namespace]
+  end
+
+  def resource
+    options[:resource]
+  end
+
+  def controller_name
+    (resource + '_controller')
+  end
+end

data/lib/generators/templates/controller.rb.erb

@@ -0,0 +1,35 @@
+class <%= namespace.camelcase %>::<%= controller_name.camelcase %> < ActionController::Base
+  include AdminBits
+
+  declare_resource :<%= resource %> do
+    # This should be path to your index action - you can create any path you like
+    path :<%= namespace %>_<%= resource %>_path
+    # Ordering contains key - sort order definitions in SQL.
+    # This is just the simplest example, for more information visit...[page]
+    ordering({
+      id: "<%= resource %>.id"
+    })
+    default_order :id
+    default_direction :asc
+    # Conditions
+    filters({
+      # name_of_the_scope: [:name_of_the_param, :name_of_another_param_passed_to_the_scope],
+      # arbitrary_filter_name: [:from, :to]
+      id_between: lambda { |f| where("items.id BETWEEN ? AND ?", f[:from], f[:to]) }
+    })
+  end
+
+  <% klass = resource.singularize.camelcase %>
+
+  def index
+    @<%= resource %> = <%= klass %>
+  end
+
+  def edit
+    @<%= resource %> = <%= klass %>.find(params[:id])
+  end
+
+  def update
+    @<%= resource %> = <%= klass %>.find(params[:id])
+  end
+end

data/lib/generators/templates/layout.html.erb

@@ -0,0 +1,3 @@
+Layout template
+
+<%= yield %>

data/test/admin_bits_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class AdminBitsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, AdminBits
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/admin/items_controller.rb

@@ -0,0 +1,40 @@
+class Admin::ItemsController < ApplicationController
+  include AdminBits
+
+  declare_resource :items do
+    path { admin_items_path }
+    ordering({
+      :name => "items.name",
+      :price => "items.price"
+    })
+    default_order :price
+    default_direction :desc
+    filters({
+      # Points to Item#having_name, passes params[:filters][:name] as the only param
+      :having_name => [:name],
+      # One can define own filter criteria of arbitrary name using lambdas
+      :price_between => lambda { |f|
+        from = f[:from].present? ? f[:from].to_i : nil
+        to   = f[:to].present? ? f[:to].to_i : nil
+
+        ret = where(nil)
+        ret = ret.where(["price <= ?", to]) if to
+        ret = ret.where(["price >= ?", from]) if from
+        ret
+      }
+    })
+    mods BasicAdminPanel
+  end
+
+  def index
+    @items = Item
+  end
+
+  def edit
+    @item = Item.find(params[:id])
+  end
+
+  def update
+    @item = Item.find(params[:id])
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/basic_admin_panel.rb

@@ -0,0 +1,65 @@
+class BasicAdminPanel
+  def initialize(controller_class, options = {})
+    controller_class.instance_eval do
+      layout "admin_bits_modules/basic_admin_panel/layout"
+
+      def columns_for_index(*columns)
+        @columns_for_index = columns
+      end
+
+      def redefine_action(action)
+        unless instance_variable_get("@#{action}_defined")
+          alias_method :"original_#{action}", action
+          remove_method action
+          instance_variable_set("@#{action}_defined", true)
+
+          define_method action do
+            send(:"original_#{action}")
+            begin
+              render "admin_bits_modules/basic_admin_panel/#{action}"
+            rescue AbstractController::DoubleRenderError
+              # Do nothing - render view specified by user
+            end
+          end
+        end
+      end
+
+      def redefine_update_action
+        action = :update
+        unless instance_variable_get("@#{action}_defined")
+          alias_method :"original_#{action}", action
+          remove_method action
+          instance_variable_set("@#{action}_defined", true)
+
+          define_method action do
+            resource = admin_resource.name.to_s.singularize
+            send(:"original_#{action}")
+            ivar = instance_variable_get("@#{resource}")
+            ivar.attributes = params[resource]
+            begin
+              if ivar.save
+                redirect_to :action => :index
+              else
+                render "admin_bits_modules/basic_admin_panel/edit"
+              end
+            rescue AbstractController::DoubleRenderError
+              # Do nothing - render view specified by user
+            end
+          end
+        end
+      end
+
+      def method_added(method_name)
+        case method_name
+        when :index, :edit, :show
+          redefine_action method_name
+        when :update
+          redefine_update_action
+        end
+      end
+    end
+
+  end
+
+
+end

data/test/dummy/app/models/item.rb

@@ -0,0 +1,7 @@
+class Item < ActiveRecord::Base
+
+  def self.having_name(name)
+    name = "%#{name}%"
+    where(["name LIKE ?", name])
+  end
+end

data/test/dummy/app/views/admin/items/index.html.erb

@@ -0,0 +1,30 @@
+<div id="filtering">
+  <%= admin_form :method => :get do %>
+    Name: <%= admin_text_filter :name %>
+    <br>
+    Price from <%= text_field_tag("filters[from]", admin_filter(:from)) %> and <%= text_field_tag("filters[to]", admin_filter(:to)) %>
+
+    <button>Filter!</button>
+  <% end %>
+</div>
+
+<table>
+  <thead>
+    <th>
+      <%= admin_link(:name, "Name") %>
+      <%= admin_link(:price, "Total price") %>
+    </th>
+  </thead>
+  <tbody>
+    <% items.each do |item| %>
+      <tr>
+        <td>
+          <%= item.name %>
+        </td>
+        <td>
+          <%= item.price %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/test/dummy/app/views/admin_bits_modules/basic_admin_panel/edit.html.erb

@@ -0,0 +1,4 @@
+<%= simple_form_for [:admin, @item] do |f| %>
+  <%= f.input :name %>
+  <%= f.button :submit %>
+<% end %>