incline 0.1.5

data/lib/incline/version.rb

@@ -0,0 +1,3 @@
+module Incline
+  VERSION = "0.1.5"
+end

data/lib/incline/work_path.rb

@@ -0,0 +1,75 @@
+module Incline
+  ##
+  # This class simply locates a temporary working directory for the application.
+  #
+  # By default we shoot for shared memory such as /run/shm or /dev/shm.  If those
+  # fail, we look to /tmp.
+  #
+  class WorkPath
+
+    ##
+    # Gets the temporary working directory location for the application.
+    #
+    def self.location
+      @location ||= get_location
+    end
+
+    ##
+    # Gets a path for a specific temporary file.
+    #
+    def self.path_for(filename)
+      location + '/' + filename
+    end
+
+    ##
+    # Gets the path to the system status file.
+    #
+    # This file is used by long running processes to log their progress.
+    #
+    def self.system_status_file
+      @system_status_file ||= path_for('system_status')
+    end
+
+    private
+
+    def self.app_name
+      @app_name ||= Rails.application.class.name.underscore.gsub('/','_')
+    end
+
+    def self.try_path(path)
+      path += '/incline_' + app_name
+
+      Incline::Log::debug "Trying path '#{path}'..."
+
+      # must exist or be able to be created.
+      unless Dir.exist?(path) || Dir.mkdir(path)
+        Incline::Log::debug 'Could not create path.'
+        return nil
+      end
+
+      # must be able to write and delete a test file.
+      test_file = path + '/test.file'
+      begin
+        File.delete(test_file) if File.exist?(test_file)
+        File.write(test_file, 'This is only a test file and can safely be deleted.')
+        File.delete(test_file)
+      rescue
+        Incline::Log::debug 'Could not create test file.'
+        path = nil
+      end
+
+      path
+    end
+
+    def self.get_location
+      %w(/run/shm /var/run/shm /dev/shm /tmp).each do |root|
+        if Dir.exist?(root)
+          loc = try_path(root)
+          return loc unless loc.blank?
+        end
+      end
+      nil
+    end
+
+  end
+end

data/lib/incline.rb

@@ -0,0 +1,197 @@
+require 'incline/version'
+require 'incline/log'
+
+##
+# A Rails quick start library.
+module Incline
+
+  ##
+  # Gets the automatic email configuration for the Incline application.
+  #
+  # The primary configuration should be stored in +config/email.yml+.
+  # If this file is missing, automatic email configuration is skipped and must be manually specified in your
+  # application's environment initializer (eg - config/environment/production.rb).
+  #
+  #   test:
+  #     ...
+  #   development:
+  #     ...
+  #   production:
+  #     default_url: www.example.com
+  #     default_recipient: contact@example.com
+  #     sender: noreply@example.com
+  #     auth: :plain
+  #     start_tls: true
+  #     ssl: false
+  #     server: smtp.example.com
+  #     port: 587
+  #
+  # You shouldn't use an open relay, a warning will be thrown if you do.
+  # But you don't want your login credentials stored in +config/email.yml+ either.
+  # Instead, credentials (if any) should be stored in +config/secrets.yml+.
+  #
+  #   test:
+  #     ...
+  #   development:
+  #     ...
+  #   production:
+  #     email:
+  #       user: noreply@example.com
+  #       password: super-secret-password
+  #     secret_key_base: ...
+  #
+  def self.email_config
+    @email_config ||=
+        begin
+          yaml = Rails.root.join('config', 'email.yml')
+          if File.exist?(yaml)
+            cfg = File.exist?(yaml) ? YAML.load_file(yaml) : { }
+            cfg = (cfg[Rails.env] || {}).symbolize_keys
+
+            cfg = {
+                port: 25,
+                auth: :plain,
+                start_tls: true,
+                ssl: false
+            }.merge(cfg)
+            
+            Incline::Log::warn 'The email configuration is missing the "user" key.' if cfg[:user].blank?
+            Incline::Log::warn 'The email configuration is missing the "password" key.' if cfg[:password].blank?
+            Incline::Log::error 'The email configuration is missing the "server" key.' if cfg[:server].blank?
+            Incline::Log::error 'The email configuration is missing the "sender" key.' if cfg[:sender].blank?
+            Incline::Log::error 'The email configuration is missing the "default_url" key.' if cfg[:default_url].blank?
+            Incline::Log::error 'The email configuration is missing the "default_recipient" key.' if cfg[:default_recipient].blank?
+
+            def cfg.valid?
+              return false if self[:sender].blank? || self[:server].blank? || self[:default_url].blank? || self[:default_recipient].blank?
+              true
+            end
+
+            cfg.freeze
+          else
+            Incline::Log::info 'The configuration file "email.yml" does not exist, automatic email configuration disabled.'
+            cfg = {}
+
+            def cfg.valid?
+              false
+            end
+
+            cfg.freeze
+          end
+        end
+
+  end
+
+  ##
+  # Gets a list of key gems with their versions.
+  #
+  # This is useful for informational displays.
+  #
+  # Supply one or more patterns for gem names.
+  # If you supply none, then the default pattern list is used.
+  def self.gem_list(*patterns)
+    patterns =
+        if patterns.blank?
+          default_gem_patterns
+        elsif patterns.first.is_a?(::TrueClass)
+          default_gem_patterns + patterns[1..-1]
+        else
+          patterns
+        end
+
+    patterns = patterns.flatten.inject([]) { |m,v| m << v unless m.include?(v); m }
+
+    gems = Gem::Specification.to_a.sort{ |a,b| a.name <=> b.name }
+
+    patterns.inject([]) do |ret,pat|
+      gems
+          .select { |g| (pat.is_a?(::String) && g.name == pat) || (pat.is_a?(::Regexp) && g.name =~ pat) }
+          .each do |g|
+        ret << [ g.name, g.version.to_s ] unless ret.find { |(name,_)| name == g.name }
+      end
+      ret
+    end
+
+  end
+
+  ##
+  # Gets a list of routes for the current application.
+  #
+  # The returned list contains hashes with :engine, :controller, :action, :name, :verb, and :path keys.
+  def self.route_list
+    @route_list ||=
+        begin
+          require 'action_dispatch/routing/inspector'
+          get_routes(Rails.application.routes.routes).sort do |a,b|
+            if a[:engine] == b[:engine]
+              if a[:controller] == b[:controller]
+                if a[:action] == b[:action]
+                  a[:path] <=> b[:path]
+                else
+                  a[:action] <=> b[:action]
+                end
+              else
+                a[:controller] <=> b[:controller]
+              end
+            else
+              a[:engine] <=> b[:engine]
+            end
+          end
+        end
+  end
+
+  ##
+  # Performs a database migration against the configured database.
+  def self.migrate!
+    ActiveRecord::Migrator.migrate File.expand_path('../../db/migrate', __FILE__), nil
+  end
+
+  private
+
+  def self.default_gem_patterns
+    @default_gem_patterns ||= [ Rails.application.class.parent_name.underscore, 'rails', /\Aincline(?:-.*)\z/ ]
+  end
+
+  def self.get_routes(routes, engine_path = '', engines = [])
+    result = []
+
+    routes = routes
+                 .collect{|r| ActionDispatch::Routing::RouteWrapper.new(r)}
+                 .reject{|r| r.internal?}
+
+    routes.each do |r|
+      if r.engine?
+        eng_path = r.path
+        unless engines.include?(eng_path)
+          eng_routes = r.rack_app.routes
+          if eng_routes.is_a?(ActionDispatch::Routing::RouteSet)
+            engines << eng_path
+            result += get_routes(eng_routes.routes, eng_path, engines)
+          end
+        end
+      else
+        result << {
+            engine:     engine_path,
+            controller: r.controller,
+            action:     r.action,
+            verb:       r.verb,
+            path:       engine_path + r.path
+        }
+      end
+    end
+
+    result.inject([]) do |ret,item|
+      existing = ret.find{|r| r[:engine] == item[:engine] && r[:controller] == item[:controller] && r[:action] == item[:action]}
+      if existing
+        existing[:verb] += '|' + item[:verb]
+      else
+        ret << item
+      end
+      ret
+    end
+  end
+
+end
+
+# Include engine after defining base module.
+require 'incline/engine'

data/lib/tasks/incline_tasks.rake

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

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

@@ -0,0 +1,43 @@
+<%%= error_summary @<%= singular_table_name %> %>
+
+<div class="col-sm-8 col-md-6 col-sm-offset-2 col-md-offset-3">
+  <div class="panel panel-primary">
+    <div class="panel-heading">
+      <%%= @<%= singular_table_name %>.new_record? ? 'New' : 'Update' %> <%= singular_table_name.titleize %>
+    </div>
+    <div class="panel-body">
+      <%%= form_for(@<%= singular_table_name %>) do |f| %>
+      <%- attributes.each do |attribute| -%>
+          <%- if attribute.type == :boolean -%>
+          <%%= f.check_box_form_group :<%= attribute.column_name %> %>
+          <%- elsif attribute.type == :date || (attribute.type == :datetime && attribute.column_name =~ /date/ && !(attribute.column_name =~ /time/)) -%>
+          <%%= f.datepicker_form_group :<%= attribute.column_name %> %>
+          <%- elsif (attribute.type == :references) || (attribute.type == :integer && attribute.column_name =~ /_id\z/)  -%>
+              <%- if (ref_class = (attribute.column_name.gsub(/_id\z/,'').classify.constantize rescue nil)) -%>
+          <%%= f.select_form_group :<%= attribute.column_name %>, <%= ref_class %>.all, :id, :to_s, label_text: <%= attribute.column_name.gsub(/_id\z/,'').humanize.inspect %>, field_class: 'form-control select2' %>
+              <%- else -%>
+          <%%= f.text_form_group :<%= attribute.column_name %>, field_type: :number, field_class: "form-control integer", label_text: <%= attribute.column_name.gsub(/_id\z/, '').humanize.inspect %> %>
+              <%- end -%>
+          <%- elsif attribute.type == :integer -%>
+          <%%= f.text_form_group :<%= attribute.column_name %>, field_type: :number, field_class: "form-control integer" %>
+          <%- elsif attribute.type == :float -%>
+          <%%= f.text_form_group :<%= attribute.column_name %>, field_type: :number, field_class: "form-control float" %>
+          <%- elsif attribute.type == :string -%>
+          <%%= f.text_form_group :<%= attribute.column_name %> %>
+          <%- elsif attribute.password_digest? -%>
+          <%%= f.text_form_group :password, field_type: :password %>
+          <%%= f.text_form_group :password_confirmation, field_type: :password %>
+          <%- else -%>
+          <div class="form-group">
+            <%%= f.label :<%= attribute.column_name %> %>
+            <%%= f.<%= attribute.field_type %> :<%= attribute.column_name %>, class: "form-control" %>
+          </div>
+          <%- end -%>
+      <%- end -%>
+      <%%= f.submit class: "btn btn-primary" %>
+      <%%= link_to "Cancel", @<%= singular_table_name %>.new_record? ? <%= index_helper %>_path : <%= singular_table_name %>_path(@<%= singular_table_name %>), class: "btn btn-default" %>
+      <%% end %>
+    </div>
+  </div>
+</div>
+

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

@@ -0,0 +1,81 @@
+<table id="dt-<%= plural_table_name %>" class="table" style="width: 100%;">
+  <thead>
+  <tr>
+    <%- attributes.reject(&:password_digest?).each do |attribute| -%>
+    <th><%= attribute.human_name %></th>
+    <%- end -%>
+    <th class="text-right"><%%= link_to 'New', new_<%= singular_table_name %>_path, class: 'btn btn-success btn-xs inline_form' %></th>
+  </tr>
+  </thead>
+</table>
+
+<%% provide :scripts do %>
+<script type="text/javascript">
+    //<![CDATA[
+    $(function() {
+        function filter_column(column, text) {
+          var dt = $('#dt-<%= plural_table_name %>').dataTable().api();
+          var col = dt.column(column);
+
+          if (col.search() !== text) {
+            col.search(text).draw();
+          }
+        }
+
+        $('#dt-<%= plural_table_name %>').DataTable({
+            dom: '<"panel-body"<"col-sm-6 col-sm-offset-6"fr>>t<"panel-body"<"col-sm-6"i><"col-sm-6"p>>',
+            ajax: {
+                url: '<%%= api_path %>',
+                type: 'POST'
+            },
+            columns: [
+                <%- attributes.reject(&:password_digest?).each do |attribute| -%>
+                {
+                    // the data to display.
+                    data: '<%= attribute.name %>',
+                    <%- if attribute.type == :boolean -%>
+                    // for booleans, show a checkmark instead of true/false.
+                    render: function (data, type) {
+                        if (type === 'display')
+                            return data ? '<i class="glyphicon glyphicon-ok glyphicon-small"></i>' : '';
+                        else
+                            return data;
+                    },
+                    <%- end -%>
+                    // can this column be used for sorting?
+                    orderable: true,
+                    // can this column be used for searching?
+                    searchable: true
+                },
+                <%- end %>
+                {
+                    orderable: false,
+                    searchable: false,
+                    data: function (row, type, set, meta) {
+                        if (type === 'display') {
+                            var ret = '<div class="text-right">';
+
+                            // the show icon.
+                            ret += '<a href="javascript:inlineForm(\'' + row.DT_Path + '\')" title="Details" class="btn btn-default btn-xs"><i class="glyphicon glyphicon-zoom-in"></i></a>';
+
+                            // the edit icon.
+                            ret += '<a href="javascript:inlineForm(\'' + row.DT_Path + '/edit\')" title="Edit" class="btn btn-default btn-xs"><i class="glyphicon glyphicon-pencil"></i></a>';
+
+                            // the delete icon.
+                            ret += '<a href="javascript:inlineAction(\'' + row.DT_Path + '\',\'delete\')" title="Remove" class="btn btn-danger btn-xs" data-confirm="Are you sure you want to remove this <%= singular_table_name.humanize %>?"><i class="glyphicon glyphicon-trash"></i></a>';
+
+                            ret += '</div>';
+                            return ret;
+                        } else {
+                            return row.DT_Path;
+                        }
+                    }
+                }
+            ],
+            responsive: true,
+            serverSide: true
+        });
+    });
+    //]]>
+</script>
+<%% end %>

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

@@ -0,0 +1 @@
+<%%= render 'form' %>

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

@@ -0,0 +1,6 @@
+<div class="panel panel-primary">
+  <div class="panel-heading">
+    <h4 class="panel-title"><%= plural_table_name.titleize %></h4>
+  </div>
+  <%%= render partial: 'list', locals: { api_path: api_<%= plural_table_name %>_path } %>
+</div>

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

@@ -0,0 +1 @@
+<%%= render 'form' %>

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

@@ -0,0 +1,34 @@
+
+<div class="col-sm-8 col-md-6 col-sm-offset-2 col-md-offset-3">
+  <div class="panel panel-primary">
+    <div class="panel-heading">
+      <h4 class="panel-title">
+        <%= singular_table_name.titleize %>
+      </h4>
+    </div>
+    <div class="panel-body">
+    <%- attributes.reject(&:password_digest?).each do |attribute| -%>
+      <div class="row">
+        <div class="col-sm-6 col-md-4">
+          <strong><%= attribute.human_name %>:</strong>
+        </div>
+        <div class="col-sm-6 col-md-8">
+          <%- if attribute.type == :boolean -%>
+          <%%= @<%= singular_table_name %>.<%= attribute.name %> ? 'Yes' : 'No' %>
+          <%- elsif attribute.type == :integer -%>
+          <%%= @<%= singular_table_name %>.<%= attribute.name %> ? number_with_delimiter(@<%= singular_table_name %>.<%= attribute.name %>) : '0' %>
+          <%- elsif attribute.type == :float -%>
+          <%%= @<%= singular_table_name %>.<%= attribute.name %> ? number_with_precision(@<%= singular_table_name %>.<%= attribute.name %>, delimiter: ',', precision: 2) : '0' %>
+          <%- elsif attribute.type == :datetime -%>
+          <%%= @<%= singular_table_name %>.<%= attribute.name %> ? @<%= singular_table_name %>.<%= attribute.name %>.strftime('%m/%d/%Y') : '[Invalid Date]'  %>
+          <%- else -%>
+          <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+          <%- end -%>
+        </div>
+      </div>
+    <%- end -%>
+      <br>
+      <%%= link_to 'Cancel', <%= index_helper %>_path, class: 'btn btn-default' %>
+    </div>
+  </div>
+</div>

data/lib/templates/jbuilder/scaffold/_details.json.jbuilder

@@ -0,0 +1,20 @@
+unless <%= singular_table_name %>.new_record?
+  json.set! 'DT_RowId', "<%= singular_table_name %>_#{<%= singular_table_name %>.id}"
+  json.set! 'DT_Path', <%= singular_table_name %>_path(<%= singular_table_name %>)
+  if <%= singular_table_name %>.destroyed?
+    json.set! 'DT_RowAction', 'remove'
+  end
+end
+<%- attributes.reject(&:password_digest?).each do |attribute| -%>
+  <%- if attribute.type == :references -%>
+json.set! '<%= attribute.name %>', h(<%= singular_table_name %>.<%= attribute.name %>.to_s)
+  <%- elsif attribute.type == :datetime || attribute.type == :time -%>
+json.set! '<%= attribute.name %>', <%= singular_table_name %>.<%= attribute.name %>&.utc&.strftime('%m/%d/%Y %H:%M:%S')
+  <%- elsif attribute.type == :date -%>
+json.set! '<%= attribute.name %>', <%= singular_table_name %>.<%= attribute.name %>&.strftime('%m/%d/%Y')
+  <%- elsif attribute.type == :string || attribute.type == :text -%>
+json.set! '<%= attribute.name %>', h(<%= singular_table_name %>.<%= attribute.name %>)
+  <%- else -%>
+json.set! '<%= attribute.name %>', <%= singular_table_name %>.<%= attribute.name %>
+  <%- end -%>
+<%- end -%>

data/lib/templates/jbuilder/scaffold/index.json.jbuilder

@@ -0,0 +1,16 @@
+if @dt_request&.provided?
+  json.set! 'draw', @dt_request.draw
+  json.set! 'recordsTotal', @dt_request.records_total
+  json.set! 'recordsFiltered', @dt_request.records_filtered
+  json.data do
+    json.array!(@dt_request.records) do |<%= singular_table_name %>|
+      json.partial! 'details', locals: { <%= singular_table_name %>: <%= singular_table_name %> }
+    end
+  end
+  if @dt_request.error?
+    json.set! 'error', @dt_request.error
+  end
+else
+  json.set! 'error', 'No data tables request received.'
+end
+json.set! 'appInfo', h(Rails.application.app_info)

data/lib/templates/jbuilder/scaffold/show.json.jbuilder

@@ -0,0 +1,16 @@
+json.messages do
+  json.array! flash.discard do |type,message|
+    json.set! 'type', type
+    json.set! 'text', message
+  end
+end
+
+if @<%= singular_table_name %>.errors.any?
+  json.api_errors! '<%= singular_table_name %>', @<%= singular_table_name %>.errors
+else
+  json.data do
+    json.array! [ @<%= singular_table_name %> ] do |<%= singular_table_name %>|
+      json.partial! 'details', locals: { <%= singular_table_name %>: <%= singular_table_name %> }
+    end
+  end
+end

data/lib/templates/rails/scaffold_controller/controller.rb

@@ -0,0 +1,128 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  before_action :set_dt_request, only: [ :index, :locate ]
+  before_action :set_new_<%= singular_table_name %>, only: [ :new, :create ]
+  before_action :set_<%= singular_table_name %>, only: [ :show, :edit, :update, :destroy ]
+
+  layout :layout_to_use
+
+  # GET <%= route_url %>
+  def index
+  end
+
+  # GET <%= route_url %>/1
+  def show
+  end
+
+  # GET <%= route_url %>/new
+  def new
+  end
+
+  # GET <%= route_url %>/1/edit
+  def edit
+  end
+
+  # POST <%= route_url %>
+  def create
+    if @<%= orm_instance.save %>
+      handle_update_success notice: <%= "'#{human_name} was successfully created.'" %>
+    else
+      handle_update_failure :new
+    end
+  end
+
+  # PATCH/PUT <%= route_url %>/1
+  def update
+    if @<%= orm_instance.update("#{singular_table_name}_params") %>
+      handle_update_success notice: <%= "'#{human_name} was successfully updated.'" %>
+    else
+      handle_update_failure :edit
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  def destroy
+    @<%= orm_instance.destroy %>
+    handle_update_success notice: <%= "'#{human_name} was successfully destroyed.'" %>
+  end
+
+  # GET/POST <%= route_url %>/api?action=...
+  def api
+    process_api_action
+  end
+
+  # POST <%= route_url %>/1/locate
+  def locate
+    render json: { record: @dt_request.record_location }
+  end
+
+private
+
+  # Inline requests do not get a layout, otherwise use the default layout.
+  def layout_to_use
+    inline_request? ? false : nil
+  end
+
+  def handle_update_failure(action)
+    if json_request?
+      # add a model-level error and render the json response.
+      @<%= singular_table_name %>.errors.add(:base, 'failed to save')
+      render 'show', formats: [ :json ]
+    else
+      # render the appropriate action.
+      render action
+    end
+  end
+
+  def handle_update_success(*messages)
+    if inline_request?
+      # inline and json requests expect json on success.
+      render 'show', formats: [ :json ]
+    else
+      # otherwise, we redirect.
+
+      # The default behavior in rails is to redirect to the item that was updated.
+      # The default behavior in incline is to redirect to the item collection.
+
+      # To reinstate the default rails behavior, uncomment the line below.
+      # redirect_to @<%= singular_table_name %>, *messages unless @<%= singular_table_name %>.destroyed?
+      redirect_to <%= index_helper %>_url, *messages
+    end
+  end
+
+  # Only allow a trusted parameter "white list" through.
+  def <%= "#{singular_table_name}_params" %>
+    if params.include?(:<%= singular_table_name %>)
+      <%- if attributes_names.empty? -%>
+      params[:<%= singular_table_name %>]
+      <%- else -%>
+      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      <%- end -%>
+    else
+      { }
+    end
+  end
+
+  # Assigns the variable used for index and locate actions.
+  def set_dt_request
+    @dt_request = Incline::DataTablesRequest.new(params) do
+      <%= orm_class.all(class_name) %>
+    end
+  end
+
+  # Assigns the variable used for new and create actions.
+  def set_new_<%= singular_table_name %>
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+  end
+
+  # Assigns the variable used for every other action.
+  def set_<%= singular_table_name %>
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+  end
+
+end
+<% end -%>