admin_bits 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 726a039e14b8abd697e9263f2cb0a4296400308c
+  data.tar.gz: 1b7822e3600d2ad2a47a5c1e398501d0bc2e7939
+SHA512:
+  metadata.gz: 11d979132be94cb24ac518b982ce8beed6f1110f827f6c6eee66d2de0079218b2276c009ff2bdb271eb5c610283a5aaf1d7a3f3830021916fd43f1e1f069ceb8
+  data.tar.gz: 542a726458c8e228679a8df973acf5a73bfe885a8993dc9d90456b2e9cdcd7b07279c0ba7289e8fa913d9e0e4ed3112e316fba4178a7ce381a50dc6b9fb8e887

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+
+gem "rails", ">= 4.0.0"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3"
+gem "kaminari"
+gem "simple_form"
+
+# group :test, :development do
+#   gem 'rspec-rails'
+# end
+
+group :test do
+  gem "rake"
+  gem "mocha"
+end
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,19 @@
+admin_bits
+==========
+
+[![Build Status](https://travis-ci.org/bitmincer/admin_bits.svg)](https://travis-ci.org/bitmincer/admin_bits)
+
+admin_bits is a gem for creating all kinds of dashboards and admin panels.
+
+## Credits
+
+admin_bits is maintained and funded by bitmincer. Thank you
+to all the [contributors][contributors].
+
+## License
+
+admin_bits is copyright © 2013-2014 bitmincer. It is free software,
+and may be redistributed under the terms specified in the
+[LICENSE](LICENSE) file.
+
+[contributors]: https://github.com/bitmincer/admin_bits/contributors

data/Rakefile

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rdoc/task'
+
+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
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AdminBits'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+

data/lib/admin_bits.rb

@@ -0,0 +1,50 @@
+module AdminBits
+  autoload :BaseConfig,     'admin_bits/base_config'
+  autoload :Helpers,        'admin_bits/helpers'
+  autoload :AdminResource,  'admin_bits/admin_resource'
+  autoload :PathHandler,    'admin_bits/admin_resource/path_handler'
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def declare_resource(name, options = {}, &block)
+      raise "Name must be Symbol" unless name.is_a?(Symbol)
+
+      ab_config = AdminBits::BaseConfig.new
+      ab_config.instance_eval &block
+
+      helper_method name
+      helper Helpers
+      helper_method :admin_resource
+      helper_method :admin_filter
+
+      define_method :admin_resource do
+        AdminResource.new(
+          name,
+          raw_resource,
+          ab_config,
+          action_name,
+          params
+        )
+      end
+
+      define_method :raw_resource do
+        instance_variable_get("@#{name}")
+      end
+
+      define_method :admin_filter do |name|
+        admin_resource.filter_params[name]
+      end
+
+      define_method name do
+        admin_resource.output
+      end
+
+      if mods = ab_config.get_mods
+        mods.new(self)
+      end
+    end
+  end
+end

data/lib/admin_bits/admin_resource.rb

@@ -0,0 +1,96 @@
+module AdminBits
+  class AdminResource
+    attr_reader :options, :resource, :request_params, :action_name, :name
+
+    def initialize(name, resource, options, action_name, request_params = {})
+      @resource       = resource
+      @options        = options
+      @request_params = request_params
+      @action_name    = action_name
+      @name           = name
+
+      raise ":path must be provided" unless @options[:path]
+
+      sanitize_params
+    end
+
+    def sanitize_params
+      @request_params = request_params.
+        with_indifferent_access.
+        reject do |k,v|
+          ["action", "controller", "commit"].include?(k) || v.blank?
+        end
+
+      request_params[:order] ||= default_order
+      request_params[:asc]   ||= default_asc
+    end
+
+    def default_order
+      options[:default_order].to_s
+    end
+
+    def default_asc
+      options[:default_direction] == :asc ? "true" : "false"
+    end
+
+    def filter_params
+      (request_params[:filters] || {}).with_indifferent_access
+    end
+
+    def filtered_resource
+      return_scope = resource
+
+      (options[:filters] || {}).each_pair do |scope_name, args|
+        if args.is_a?(Array)
+          args = args.map {|a| filter_params[a] }
+
+          return_scope = return_scope.send(scope_name, *args)
+        else
+          return_scope = return_scope.instance_exec filter_params, &args
+        end
+      end
+
+      return_scope
+    end
+
+    def output
+      # Paginator.new(filtered_resource.order(get_order), get_page).call
+      filtered_resource.order(get_order).page(get_page)
+    end
+
+    def original_url
+      PathHandler.new(options[:path], request_params).path
+    end
+
+    def url(params = {})
+      PathHandler.new(options[:path], request_params).with_params(params)
+    end
+
+    def get_page
+      request_params[:page]
+    end
+
+    def get_order
+      order = request_params[:order]
+
+      if order.blank?
+        nil
+      else
+        convert_mapping(options[:ordering][order.to_sym])
+      end
+    end
+
+    def get_direction
+      request_params[:asc] != "true" ? "DESC" : "ASC"
+    end
+
+    def convert_mapping(mapping)
+      # Check if mapping was provided
+      raise "No order mapping specified for '#{order}'" if mapping.blank?
+      # Convert to array in order to simplify processing
+      mapping = [mapping] if mapping.is_a?(String)
+      # Convert to SQL form
+      mapping.map {|m| "#{m} #{get_direction}"}.join(", ")
+    end
+  end
+end

data/lib/admin_bits/admin_resource/paginator.rb

@@ -0,0 +1,14 @@
+class AdminBits::AdminResource::Paginator
+  attr_reader :resource, :page, :options
+
+  def initialize(resource, page, options)
+    @resource = resource
+    @page     = page || 1
+    @options  = options
+  end
+
+  def paginate
+    per_page = 30
+    resource.slice((page - 1) * per_page, page * per_page)
+  end
+end

data/lib/admin_bits/admin_resource/path_handler.rb

@@ -0,0 +1,34 @@
+class AdminBits::AdminResource::PathHandler
+  attr_reader :request_params, :unprocessed_path
+
+  def initialize(path, request_params)
+    @request_params = request_params
+    @unprocessed_path = path
+  end
+
+  def path
+    @path ||= begin
+      if unprocessed_path.is_a?(Proc)
+        @path = routes.instance_exec(request_params, &unprocessed_path)
+      elsif unprocessed_path.is_a?(String)
+        @path = unprocessed_path
+      else
+        unknown_argument_type
+      end
+    end
+  end
+
+  def with_params(params = {})
+    path + "?" + request_params.merge(params).to_param
+  end
+
+  private
+
+  def routes
+    Rails.application.routes.url_helpers
+  end
+
+  def unknown_argument_type
+    raise "Wrong type of argument"
+  end
+end