carload 0.1.0

data/lib/carload/dashboard.rb

@@ -0,0 +1,47 @@
+module Carload
+  class Dashboard
+    class ModelSpec
+      attr_accessor :default, :attributes, :index_page, :associated_models
+
+      def initialize
+        @default = false
+        @attributes = ExtendedHash.new
+        @index_page = ExtendedHash.new
+        @index_page[:shows] = ExtendedHash.new
+        @index_page[:searches] = ExtendedHash.new
+        @associated_models = {}
+      end
+    end
+
+    class << self
+      def model name, &block
+        if block_given?
+          @@models ||= {}
+          spec = ModelSpec.new
+          yield spec
+          @@models[name] = spec
+        else
+          @@models[name]
+        end
+      end
+
+      def associate args
+        model_a = args.keys.first
+        model_b = args.values.first
+        @@models[model_a].associated_models[model_b] = args[:choose_by]
+        @@models[model_b].associated_models[model_a] = nil
+      end
+
+      def models
+        @@models ||= {}
+      end
+
+      def default_model
+        return @@default_model if defined? @@default_model
+        @@models.each do |name, spec|
+          return @@default_model = name if spec.default
+        end
+      end
+    end
+  end
+end

data/lib/carload/engine.rb

@@ -0,0 +1,12 @@
+module Carload
+  class Engine < ::Rails::Engine
+    isolate_namespace Carload
+
+    initializer :set_autoload_paths do |app|
+      # Load dashboard.rb in app.
+      Dir.glob("#{app.root}/app/carload/*.rb").each do |file|
+        require_dependency file
+      end
+    end
+  end
+end

data/lib/carload/exceptions.rb

@@ -0,0 +1,17 @@
+module Carload
+  class Error < StandardError
+    attr_reader :message
+  end
+
+  class UnmanagedModelError < Error
+    def initialize data
+      @message = I18n.t('carload.error.message.unmanaged_model', model: data)
+    end
+  end
+
+  class UnsupportedError < Error
+    def initialize data
+      @message = "Carload does not support #{data} currently."
+    end
+  end
+end

data/lib/carload/extended_hash.rb

@@ -0,0 +1,12 @@
+module Carload
+  class ExtendedHash < Hash
+    def method_missing method, *args, &block
+      key = method.to_s.gsub('=', '').to_sym
+      if method.to_s =~ /=$/
+        self[key] = args.first
+      else
+        self[key]
+      end
+    end
+  end
+end

data/lib/carload/version.rb

@@ -0,0 +1,3 @@
+module Carload
+  VERSION = '0.1.0'
+end

data/lib/carload.rb

@@ -0,0 +1,27 @@
+# Require all dependencies (Rails does not do this for us in default).
+Gem.loaded_specs['carload'].dependencies.each do |dependency|
+  require dependency.name
+end
+
+require 'carload/extended_hash'
+require 'carload/dashboard'
+require 'carload/engine'
+require 'carload/exceptions'
+
+module Carload
+  def self.setup &block
+    @@config = ExtendedHash.new
+    @@config[:dashboard] = ExtendedHash.new
+    @@config[:dashboard][:permits_user] = ExtendedHash.new
+    yield @@config
+    if not [:devise, :none].include? @@config[:auth_solution]
+      raise UnsupportedError.new("authentication solution #{@@config[:auth_solution]}")
+    end
+
+    @@config.each do |key, value|
+      define_singleton_method key do
+        value
+      end
+    end
+  end
+end

data/lib/generators/carload/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Mount Carload routes.
+
+    Copy initializer and dashboard template files.
+
+Example:
+    rails generate carload:install
+
+    This will modify:
+        config/routes.rb
+        config/application.rb
+
+    This will create:
+        config/initializers/carload.rb
+        app/carload/dashboard.rb

data/lib/generators/carload/install_generator.rb

@@ -0,0 +1,30 @@
+module Carload
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def mount_routes
+      return if File.read('config/routes.rb').include? 'mount Carload::Engine'
+      inject_into_file 'config/routes.rb', after: "Rails.application.routes.draw do\n" do <<-RUBY
+  mount Carload::Engine => '/carload'
+      RUBY
+      end
+    end
+
+    def add_require
+      return if File.read('config/application.rb') =~ /require ['|"]carload['|"]/
+      inject_into_file 'config/application.rb', after: "Bundler.require(*Rails.groups)\n" do <<-RUBY
+require 'carload'
+      RUBY
+      end
+    end
+
+    def copy_initializer
+      return if File.exist? 'config/initializers/carload.rb'
+      copy_file 'carload.rb', 'config/initializers/carload.rb'
+    end
+
+    def copy_dashboard_file
+      copy_file 'dashboard.rb', 'app/carload/dashboard.rb'
+    end
+  end
+end

data/lib/generators/carload/templates/carload.rb

@@ -0,0 +1,18 @@
+Carload.setup do |config|
+  # Specify which authentication solution is used. Currently, we only support Devise.
+  config.auth_solution = :devise
+
+  # Set the actions used to discern user's permission to access dashboard.
+  #
+  #   config.dashboard.permits_user.<method> = '...'
+  #
+  # There are four access methods can be configured:
+  #
+  #   index, new, edit, destroy
+  #
+  # Also you can use a special method 'all' to set the default permission.
+  # The permission can also be array, the relation among them is OR.
+  # By doing this, you have full control on the access permission.
+  # TODO: Set the permissions for each data table.
+  config.dashboard.permits_user.all = 'role.admin?'
+end

data/lib/generators/carload/templates/dashboard.rb

@@ -0,0 +1,19 @@
+# Dashboard class is used to tell Carload what models are needed to administrated,
+# which attributes are shown, etc.
+
+class Dashboard < Carload::Dashboard
+  # There are two DSL block types:
+  #
+  #   model :<model_name> do |spec|
+  #     # Whether model should be displayed when URL does not specify one
+  #     spec.default = <true_or_false>
+  #     # List of attributes that can be edited
+  #     spec.attributes.permitted = [...]
+  #     # List of attributes that will be shown on index page
+  #     spec.index_page.shows.attributes = [...]
+  #     # List of attributes with search terms that can be searched on index page (using Ransack gem)
+  #     spec.index_page.searches.attributes = [ { name: ..., term: ...}, ... ]
+  #   end
+  #
+  #   associate :<model_name_a> => :<model_name_b>, choose_by: :<attribute_in_model_b>
+end

data/lib/tasks/carload_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :carload do
+#   # Task goes here
+# end

data/lib/templates/erb/scaffold/_form.html.erb

@@ -0,0 +1,13 @@
+<%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
+  <%%= f.error_notification %>
+
+  <div class="form-inputs">
+  <%- attributes.each do |attribute| -%>
+    <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
+  <%- end -%>
+  </div>
+
+  <div class="form-actions">
+    <%%= f.button :submit %>
+  </div>
+<%% end %>

metadata

@@ -0,0 +1,277 @@
+--- !ruby/object:Gem::Specification
+name: carload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Li Dong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: turbolinks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: font-awesome-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: select2-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Carload is built with taste, and tries to be just right!
+email:
+- dongli.init@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/carload_manifest.js
+- app/assets/javascripts/carload/application.js
+- app/assets/javascripts/carload/dashboard.js
+- app/assets/stylesheets/carload/_select2.scss
+- app/assets/stylesheets/carload/application.scss
+- app/assets/stylesheets/carload/colors.scss
+- app/assets/stylesheets/carload/common.scss
+- app/assets/stylesheets/carload/dashboard.scss
+- app/assets/stylesheets/carload/error.scss
+- app/controllers/carload/application_controller.rb
+- app/controllers/carload/dashboard_controller.rb
+- app/controllers/carload/errors_controller.rb
+- app/helpers/carload/application_helper.rb
+- app/helpers/carload/dashboard_helper.rb
+- app/jobs/carload/application_job.rb
+- app/mailers/carload/application_mailer.rb
+- app/models/carload/application_record.rb
+- app/policies/application_policy.rb
+- app/policies/dashboard_policy.rb
+- app/views/carload/dashboard/_form.html.erb
+- app/views/carload/dashboard/edit.html.erb
+- app/views/carload/dashboard/index.html.erb
+- app/views/carload/dashboard/new.html.erb
+- app/views/carload/dashboard/shared/_index_buttons.html.erb
+- app/views/carload/dashboard/shared/_search_fields.html.erb
+- app/views/carload/errors/dashboard_error.html.erb
+- app/views/carload/errors/unauthorized_error.html.erb
+- app/views/kaminari/_first_page.html.erb
+- app/views/kaminari/_gap.html.erb
+- app/views/kaminari/_last_page.html.erb
+- app/views/kaminari/_next_page.html.erb
+- app/views/kaminari/_page.html.erb
+- app/views/kaminari/_paginator.html.erb
+- app/views/kaminari/_prev_page.html.erb
+- app/views/layouts/carload/application.html.erb
+- app/views/layouts/carload/dashboard.html.erb
+- config/initializers/assets.rb
+- config/initializers/simple_form.rb
+- config/initializers/simple_form_bootstrap.rb
+- config/locales/en.yml
+- config/locales/simple_form.en.yml
+- config/locales/zh-CN.yml
+- config/routes.rb
+- lib/carload.rb
+- lib/carload/dashboard.rb
+- lib/carload/engine.rb
+- lib/carload/exceptions.rb
+- lib/carload/extended_hash.rb
+- lib/carload/version.rb
+- lib/generators/carload/USAGE
+- lib/generators/carload/install_generator.rb
+- lib/generators/carload/templates/carload.rb
+- lib/generators/carload/templates/dashboard.rb
+- lib/tasks/carload_tasks.rake
+- lib/templates/erb/scaffold/_form.html.erb
+homepage: https://github.com/dongli/carload
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Another Rails administration dashboard gem.
+test_files: []
+has_rdoc: