basepack 0.0.2

data/lib/basepack/utils.rb

@@ -0,0 +1,225 @@
+module Basepack
+  module Utils
+    def self.model_config(resource_class)
+      model_config = RailsAdmin.config(resource_class)
+      raise ArgumentError.new("Model #{resource_class.inspect} not known by RailsAdmin") unless model_config
+      raise ArgumentError.new("Model #{resource_class.inspect} excluded from RailsAdmin") if model_config.excluded?
+      model_config
+    end
+
+    def self.detect_models
+      ([Rails.application] + Rails::Engine::Railties.engines).map do |app|
+        app.paths['app/models'].to_a.map do |load_path|
+          Dir.glob(app.root.join(load_path)).map do |load_dir|
+            Dir.glob(load_dir + "/**/*.rb").map do |filename|
+              # app/models/module/class.rb => module/class.rb => module/class => Module::Class
+              filename.reverse.chomp("#{app.root.join(load_dir)}/".reverse).reverse.chomp('.rb').camelize
+            end
+          end
+        end
+      end.flatten
+    end
+
+    def self.query_from_params(scope, params, options = {})
+      config = options[:config] || model_config(scope.klass)
+      scope = paginate(query(scope, params, config), params)
+      filter(scope, params, config, options)
+    end
+
+    def self.filter(scope, params, config, options = {})
+      auth_object = options[:auth_object]
+      filter = params[:f].is_a?(Hash) ? params[:f] : {}
+      custom_filters = []
+      error = nil
+
+      if params[:ql].present?
+        begin
+          filter = filter.merge(FilterQL.new(options[:filterql_options]).parse(params[:ql]))
+        rescue FilterQL::ParseError => e
+          error = e.message
+        end
+      end
+
+      # default sorting
+      #
+      if filter[:s].blank? and config.query.sort_by
+        sort_by = config.query.sort_by.to_sym
+        if field = config.query.fields.find {|f| f.name == sort_by }
+          columns = field_sortable_columns(field)
+          if columns.present?
+            filter = filter.merge(s: Hash[columns.map.with_index do |c, i|
+              [ i.to_s, { name: c[0], dir: c[1] ^ config.query.sort_reverse? ? 'desc' : 'asc' } ]
+            end])
+          end
+        end
+      end
+
+      # custom filters
+      #
+      filter.each do |k, v|
+        if k == "c"
+          # {"c"=>{"28054"=>{"a"=>{"0"=>{"name"=>"tag"}}, "p"=>"cont", "v"=>{"0"=>{"value"=>"test"}}}}}
+          #
+          v.each_value do |cond|
+            f = [cond["a"]["0"]["name"], cond["p"] || 'eq', cond["v"].try(:[], "0").try(:[], "value")]
+            method = cond["p"] ? "filter_#{f[0]}_#{f[1]}" : "filter_#{f[0]}"
+            if scope.klass.respond_to? method
+              scope = scope.klass.send(method, scope, f[2], auth_object)
+              custom_filters << f
+            end
+          end
+        elsif k =~ /\A(.*)_((?:(?:does_)?not_)?[a-z]+)\z/
+          atr = $1
+          predicate = $2
+          method = "filter_#{k}".sub(/_eq\z/, '')
+          if scope.klass.respond_to? method
+            scope = scope.klass.send(method, scope, v, auth_object)
+            custom_filters << [atr, predicate, v]
+          end
+        end
+      end
+
+      resource_filter = scope.ransack(filter, search_key: :f, auth_object: auth_object)
+      resource_filter.errors[:base] = [error] if error
+      resource_filter.custom_filters = custom_filters
+      scope = resource_filter.result(distinct: true)
+      [resource_filter, scope]
+    end
+
+    def self.paginate(scope, params)
+      scope = scope.page(params[:page].presence || 1)
+      scope = scope.per(params[:per].presence) if params[:per].presence
+      scope
+    end
+
+    def self.query(scope, params, config)
+      query = params[:query]
+
+      if query.present?
+        or_arel = []
+        model = config.abstract_model.model
+        object = nil
+        dquery = query.downcase
+
+        if model.respond_to?(:default_query)
+          return scope.merge(model.send(:default_query, query))
+        end
+
+        config.query.fields.select(&:queryable?).map do |field|
+          field.searchable_columns.each do |column_infos|
+            column = model.arel_table[column_infos[:column][/([^.]+)$/, 1].to_sym]
+
+            case column_infos[:type]
+            when :integer
+              begin
+                or_arel << column.eq(Integer(query))
+              rescue ArgumentError
+              end
+            when :decimal, :float
+              begin
+                or_arel << column.eq(Float(query))
+              rescue ArgumentError
+              end
+            when :string, :text
+              or_arel << column.matches("%#{query}%")
+            when :boolean
+              if Ransack::Constants::TRUE_VALUES.include? query
+                or_arel << column.eq(true)
+              elsif Ransack::Constants::FALSE_VALUES.include? query
+                or_arel << column.eq(false)
+              end
+            when :date
+              begin
+                or_arel << column.eq(Time.zone.parse(query).to_date)
+              rescue ArgumentError, NoMethodError
+              end
+            when :datetime, :timestamp
+              begin
+                date = Time.zone.parse(query).to_datetime
+                if date.midnight - date == 0
+                  or_arel << column.gteq(date).and(column.lt(date.advance(:days => 1)))
+                elsif date.sec_fraction == 0
+                  if date.sec == 0
+                    or_arel << column.gteq(date).and(column.lt(date.advance(:minutes => 1)))
+                  else
+                    or_arel << column.gteq(date).and(column.lt(date.advance(:seconds => 1)))
+                  end
+                else
+                  or_arel << column.eq(date)
+                end
+              rescue ArgumentError, NoMethodError
+              end
+            when :enum
+              values = nil
+              if model.respond_to? :enumerized_attributes
+                # enumerize
+                if enum_attrs = model.enumerized_attributes[column.name]
+                  values = enum_attrs.values.map do |e_val|
+                    e_val.value if e_val == query or e_val.value == query or e_val.text.downcase.include?(dquery)
+                  end.compact
+                end
+              else
+                enum_method = "#{column.name}_enum"
+                if model.respond_to?(enum_method)
+                  options = model.send(enum_method)
+                else
+                  object ||= model.new
+                  options = object.try(enum_method)
+                end
+                values = options.map do |o|
+                  o[1] if o[0].to_s.downcase.include?(dquery) or o[1].to_s.downcase.include?(dquery)
+                end.compact if options
+              end
+              or_arel << column.in(values) if values.present?
+            end
+          end
+        end
+
+        scope = or_arel.present? ? scope.where(or_arel.map {|a| a.to_sql}.join(' OR ')) : scope.where("0") # none
+      end
+
+      scope
+    end
+
+    def self.field_sortable_columns(field)
+      sort_reverse = field.sort_reverse
+      Array.wrap(field.sortable).map do |sort|
+        if sort == true
+          # use field for sorting
+          [ field.name.to_s, sort_reverse ]
+        elsif sort == false
+          # asked field is not sortable
+          nil
+        elsif (sort.is_a?(String) || sort.is_a?(Symbol)) and sort.to_s.include?('.')
+          # just provide sortable, don't do anything smart
+          [ sort.to_s, sort_reverse ]
+        elsif sort.is_a?(Hash)
+          # just join sortable hash, don't do anything smart
+          [ "#{sort.keys.first}_#{sort.values.first}", sort_reverse ]
+        else
+          if sort.is_a? Array
+            sort, order = sort
+          else
+            order = sort_reverse
+          end
+          [
+            field.association? ? "#{field.associated_model_config.abstract_model.table_name}_#{sort}" : sort.to_s,
+            order
+          ]
+        end
+      end.compact
+    end
+
+    def self.translate(resource, action, subaction = '')
+      resource_class = (Class === resource) ? resource : resource.class
+      model_name = resource_class.model_name.singular
+      lookups = []
+      lookups << :"basepack.forms.#{model_name}.#{action}.#{subaction}"
+      lookups << :"basepack.actions.#{action}.#{subaction}"
+      lookups << :"admin.actions.#{action}.#{subaction}"
+
+      I18n.t(lookups.shift, default: lookups).presence
+    end
+  end
+end
+

data/lib/basepack/version.rb

@@ -0,0 +1,3 @@
+module Basepack
+  VERSION = "0.0.2".freeze
+end

data/lib/basepack.rb

@@ -0,0 +1,215 @@
+require "basepack/engine"
+require 'basepack/version'
+require 'basepack/sections/query'
+require 'basepack/sections/import'
+require 'basepack/sections/bulk_edit'
+
+module Basepack
+  def self.setup
+
+    Array.class_eval do
+      def to_csv(schema = {}, options = {})
+        if all? {|o| o.respond_to?(:to_csv)}
+          map {|o| o.to_csv(schema, options) }.join
+        else
+          CSV.generate_line(self, options.reverse_merge(encoding: 'UTF-8'))
+        end
+      end
+    end
+
+    ActiveRecord::Base.class_eval do
+      def to_label
+        send(Basepack::Settings.to_label_methods.find {|m| respond_to?(m)} || :to_s)
+      end
+
+      def to_details_label
+        @view ||= begin
+          view = ActionView::Base.new(ActionController::Base.view_paths, {})
+          view.extend ApplicationHelper
+          view
+        end
+        begin
+          @view.render(partial: "#{self.class.model_name.route_key}/details_label", layout: false, locals: { resource: self } ).html_safe
+        rescue ActionView::MissingTemplate
+          to_label
+        end
+      end
+
+      def labelize(&block)
+        if new_record?
+          ""
+        else
+          yield.to_s.truncate(40, :separator => ' ')
+        end
+      end
+
+      def to_csv(schema = {}, options = {})
+        schema = { include_root_in_json: false }.reverse_merge!(schema)
+        values = Basepack.map_value_csv(as_json(schema))
+        CSV.generate_line(values, options.reverse_merge(encoding: 'UTF-8'))
+      end
+
+      #def self.ransackable_attributes(auth_object = nil)
+      #  authorizer = active_authorizer[:default]
+      #  super(auth_object).reject {|a| a != 'id' && authorizer.deny?(a)}
+      #end
+
+      #def self.ransackable_associations(auth_object = nil)
+      #  authorizer = active_authorizer[:default]
+      #  super(auth_object).reject {|a| authorizer.deny?("#{a}_id") && authorizer.deny?("#{a}_attributes")}
+      #end
+    end
+
+    ActionController::Renderers.add :csv do |obj, options|
+      filename = options[:filename] || 'data'
+      str = obj.respond_to?(:to_csv) ? obj.to_csv : obj.to_s
+      send_data str, :type => Mime::CSV, :disposition => "attachment; filename=#{filename}.csv"
+    end
+
+    if defined? Ransack
+      Ransack::Search.class_eval do
+        def errors
+          @errors_patch ||= {}
+        end
+
+        attr_accessor :custom_filters
+      end
+    end
+
+    if defined? RailsAdmin
+      RailsAdmin::Config::Fields::Association.class_eval do
+        alias pretty_value! pretty_value
+
+        register_instance_option :pretty_value do
+          if RailsAdmin::ApplicationController === bindings[:controller]
+            pretty_value!
+          else
+            bindings[:view].form_field_show_association(self)
+          end
+        end
+
+        register_instance_option :options_source do
+          begin
+            bindings[:view].url_for([:options, associated_model_config.abstract_model.model])
+          rescue
+              Rails.logger.debug <<-MESSAGE.strip_heredoc
+
+
+              [Basepack] Please add routes for '#{associated_model_config.abstract_model.model}' - url_for([:options, #{associated_model_config.abstract_model.model}]) failed
+
+              MESSAGE
+            "/#{associated_model_config.abstract_model.model.name.parameterize}-options-url-not-exists"
+          end
+        end
+
+        register_instance_option :options_source_params do
+          {}
+        end
+
+        register_instance_option :partial_show do
+          nil
+        end
+      end
+
+      RailsAdmin::Config::Sections::List.class_eval do
+        register_instance_option :bulk_actions do
+          false
+        end
+      end
+
+      RailsAdmin::Config::Fields::Base.class_eval do
+        alias export_value! export_value
+
+        register_instance_option :export_value do
+          formatted_value
+        end
+      end
+
+      RailsAdmin::Config::Fields::Types::Datetime.class_eval do
+        alias export_value! export_value
+
+        register_instance_option :export_value do
+          unless (time = value).nil?
+            I18n.l(time, format: "%d.%m.%Y %T")
+          else
+            ""
+          end
+        end
+
+        register_instance_option :bulk_edit_partial do
+          nil
+        end
+      end
+
+      RailsAdmin::Config::Fields::Types::Time.class_eval do
+        register_instance_option :export_value do
+          export_value!
+        end
+      end
+
+      #RailsAdmin::Config::Fields::Types::Enum.class_eval do
+      #  register_instance_option :pretty_value do
+      #    v = bindings[:object].send(name)
+      #    v ? v.text : ' - '
+      #  end
+      #end
+
+      #RailsAdmin::Adapters::ActiveRecord.class_eval do
+      #  private
+
+      #  alias build_statement! build_statement
+
+      #  def build_statement(column, type, value, operator)
+      #    result = build_statement!(column, type, value, operator)
+      #    return unless result.present?
+
+      #    case type
+      #    when :enum
+      #      if operator == '_blank' || value == '_blank'
+      #        result = ["(#{column} IS NULL)"]
+      #      elsif operator == '_present' || value == '_present'
+      #        result = ["(#{column} IS NOT NULL)"]
+      #      else
+      #        in_values = {}
+      #
+      #        if enum_attrs = model.enumerized_attributes[column[/([^.]+)$/, 1].to_sym]
+      #          enum_values = enum_attrs.values
+
+      #          values = Array.wrap(value).each do |val|
+      #            enum_values.each do |e_val| 
+      #              if e_val == val or e_val.value == val or e_val.text.downcase.include?(val.downcase)
+      #                in_values[e_val.value] = true
+      #              end
+      #            end
+      #          end
+      #        end
+
+      #        result = in_values.empty? ? nil : ["(#{column} IN (?))", in_values.keys]
+      #      end
+      #    end
+
+      #    return result
+      #  end
+      #end
+    end
+  end
+
+  def self.map_value_csv(value)
+    case value
+    when Hash
+      value.map {|k, v| map_value_csv(v) }.flatten
+    when Array
+      arr = value.map {|v| Array.wrap(map_value_csv(v)) }
+      arr.empty? ? arr : arr.first.zip(*arr[1..-1]).map {|a| a.join(',')}
+    else
+      value
+    end
+  end
+
+  class Railtie < ::Rails::Railtie
+    config.app_generators.template_engine :basepack
+    config.app_generators.resource_route :basepack_resource_route
+    config.app_generators.scaffold_controller :basepack_controller
+  end
+
+end

data/lib/generators/basepack/install_generator.rb

@@ -0,0 +1,185 @@
+module Basepack
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates a Basepack initializer and copy locale files to your application."
+
+      def self.next_migration_number(path)
+        if ActiveRecord::Base.timestamped_migrations
+          sleep 1 # make sure each time we get a different timestamp
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(path) + 1)
+        end
+      end
+
+      def add_assets
+        js_manifest = 'app/assets/javascripts/application.js'
+        if File.exist?(js_manifest)
+          insert_into_file js_manifest, "//= require jquery\n", :before => "\n//= require"
+          insert_into_file js_manifest, "//= require basepack\n", :after => "jquery_ujs\n"
+          insert_into_file js_manifest, "//= require jquery.turbolinks\n", :after => "jquery\n"
+        else
+          copy_file "application.js", js_manifest
+        end
+
+        css_manifest = 'app/assets/stylesheets/application.css'
+        scss_manifest = 'app/assets/stylesheets/application.css.scss'
+        if File.exist?(css_manifest)
+          content = File.read(css_manifest)
+          insert_into_file css_manifest, " *= require basepack\n *= require basepack_and_overrides\n", :after => "require_self\n"
+          copy_file "basepack_and_overrides.css", "app/assets/stylesheets/basepack_and_overrides.css"
+        elsif File.exists?(scss_manifest)
+          content = File.read(scss_manifest)
+          append_file scss_manifest, '@import "basepack";'
+          append_file scss_manifest, '@import "basepack_and_overrides";'
+          copy_file "basepack_and_overrides.css", "app/assets/stylesheets/basepack_and_overrides.css"
+        else
+          copy_file "application.css.scss", "app/assets/stylesheets/application.css.scss"
+        end
+      end
+
+      def check_cancan
+        if !defined?(Devise) and yes?("Would you like to install CanCan?")
+          gem 'cancan'
+          generate "cancan:ability"
+        end
+      end
+
+      def check_devise
+        #othervise error: undefined local variable or method `current_user'
+        if !defined?(CanCan) and yes?("Would you like to install Devise?")
+          gem "devise"
+          generate "devise:install"
+          model_name = ask("What would you like the user model to be called? [user]")
+          model_name = "user" if model_name.blank?
+          generate "devise", model_name
+        end
+      end
+
+      def add_dependant_gems
+        gem 'jquery-turbolinks'
+        gem 'inherited_resources',  '~> 1.4.1'
+        gem 'ransack',              '~> 1.0'
+        gem 'kaminari'
+        gem "simple_form",          '~> 3.0.0.rc'
+        gem 'settingslogic'
+        gem "twitter-bootstrap-rails"
+        gem 'bootbox-rails'
+
+
+        #needed for imports
+        gem 'rack-cache', :require => 'rack/cache'
+        gem 'dragonfly' # images
+        gem 'delayed_job_active_record', ">= 4.0.0.beta2"
+
+
+        #used in filters
+        gem "strip_attributes", "~> 1.2"
+      end
+
+      def copy_files
+        template "basepack-settings.yml", "config/basepack-settings.yml"
+        copy_file "../../../../config/locales/en.yml", "config/locales/basepack.en.yml"
+        directory 'layouts', 'app/views/layouts/'
+        copy_file "resources_controller.rb", "app/controllers/resources_controller.rb"
+
+        app_file = 'app/views/layouts/application.html.erb'
+        if File.exists?(app_file) and yes?("Can I remove #{app_file}?")
+          run("rm #{app_file}")
+        end
+
+        insert_into_file 'config/routes.rb', :after => "draw do\n" do <<-'RUBY'
+  concern :resourcable do
+      get    'options',     :on => :collection
+      get    'query',       :on => :collection
+      post   'query',       :on => :collection
+      get    'export',      :on => :collection
+      post   'export',      :on => :collection
+      get    'import',      :on => :collection
+      post   'import',      :on => :collection
+      patch  'import',      :on => :collection
+      delete 'import',      :on => :collection
+      delete 'bulk_delete', :on => :collection
+
+      get    'filters',     :on => :collection
+      get    'taggings',     :on => :collection
+      #patch  'list_columns', :on => :collection
+      #put    'list_columns', :on => :collection
+
+      get    'bulk_edit',   on: :collection
+      patch  'bulk_update', on: :collection
+      post   'bulk_update', on: :collection
+end
+
+  resources :filters, concerns: :resourcable
+
+  # Uncomment if you are going to use tags (you also need get "acts-as-taggable-on")
+  #
+  # resources :acts_as_taggable_on_tags, concerns: :resourcable
+
+  # Exampe of controller which merge action:
+  #
+  # resources :customers do
+  #   get    'diff/:id2',   on: :member, to: :diff, as: :diff    #for showing a diff page
+  #   post   'merge/:id2',  on: :member, to: :merge, as: :merge  #for mege action
+  # end
+
+RUBY
+        end
+      end
+
+      def rails_admin_init_script
+        rails_admin_cfg_file = 'config/initializers/rails_admin.rb'
+        if File.exist?(rails_admin_cfg_file)
+          insert_into_file rails_admin_cfg_file, "  config.included_models = Basepack::Utils.detect_models #+ ['ActsAsTaggableOn::Tag', 'Delayed::Job']\n", :before => "end\n"
+        else
+          copy_file "rails_admin.rb", rails_admin_cfg_file
+        end
+      end
+
+      def create_imports
+         #TODO - should I ask whether generate?
+         copy_migrate 'create_imports'
+         copy_migrate 'create_imports_importables_join_table'
+         copy_file 'import.rb', 'app/models/import.rb'
+
+         copy_file 'dragonfly.rb', 'config/initializers/dragonfly.rb'
+      end
+
+      def create_saved_filters
+         #TODO - should I ask whether generate?
+         copy_migrate 'create_filters'
+         copy_file 'filter.rb', 'app/models/filter.rb'
+         copy_file 'filters_controller.rb', 'app/controllers/filters_controller.rb'
+
+        ability_model_file = 'app/models/ability.rb'
+        if File.exists?(ability_model_file)
+          insert_into_file ability_model_file, "    can :read, Filter\n    can :manage, Filter, :user_id => user.id if user\n", :after => "def initialize(user)\n"
+        end
+        user_model_file =  'app/models/user.rb'
+        if File.exists?(user_model_file)
+          insert_into_file user_model_file, "  has_many :filters, inverse_of: :user", :after => "class User < ActiveRecord::Base\n"
+        end
+      end
+
+
+      #def show_readme
+      #  readme "README" if behavior == :invoke
+      #end
+
+    private
+
+      def copy_migrate(filename)
+        if self.class.migration_exists?("db/migrate", "#{filename}")
+          say_status("skipped", "Migration #{filename}.rb already exists")
+        else
+          migration_template "migrations/#{filename}.rb", "db/migrate/#{filename}.rb"
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/basepack/scaffold/scaffold_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators/erb/scaffold/scaffold_generator'
+
+module Basepack
+  module Generators
+    class ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
+
+      def copy_view_files
+      end
+
+    end
+  end
+end

data/lib/generators/basepack/templates/application.css.scss

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ */
+
+@import "basepack";
+

data/lib/generators/basepack/templates/application.js

@@ -0,0 +1,20 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery.turbolinks
+//= require jquery_ujs
+//= require basepack
+// #= require bootstrap-wysihtml5
+// #= require bootstrap-wysihtml5/locales
+//= require turbolinks
+//= require_tree .

data/lib/generators/basepack/templates/basepack-settings.yml

@@ -0,0 +1,15 @@
+defaults: &defaults
+  to_label_methods: [name, title]
+  help:
+    title: false
+  filters:
+    model_name: Filter
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults