ditty 0.8.0 → 0.10.2

data/lib/ditty/generators/project_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'thor/group'
+require 'active_support/inflector'
+
+module Ditty
+  module Generators
+    class ProjectGenerator < Thor::Group
+      include Thor::Actions
+
+      attr_reader :name, :namespace, :folder
+
+      desc 'Initialize a new Ditty project in the current folder'
+
+      def setup
+        @name      = File.basename(Dir.getwd)
+        @folder    = @name.underscore
+        @namespace = folder.classify
+        @name      = @name.titleize
+      end
+
+      def self.source_root
+        File.expand_path('../templates', __dir__)
+      end
+
+      def create_startup_files
+        directory 'logs'
+        directory 'pids'
+        directory 'public'
+        directory '../../../views', 'views'
+        copy_file '.gitignore', './.gitignore'
+        copy_file 'env.example', './.env'
+        copy_file '.rubocop.yml', './.rubocop.yml'
+        copy_file '.rspec', './.rspec'
+
+        template 'lib/project.rb.erb', "lib/#{folder}.rb"
+
+        copy_file 'application.rb', './application.rb'
+        copy_file 'config.ru', './config.ru'
+        copy_file 'Rakefile', './Rakefile'
+        copy_file 'sidekiq.rb', './config/sidekiq.rb'
+        copy_file 'sidekiq.yml', './config/sidekiq.yml'
+
+        copy_file 'spec_helper.rb', './specs/spec_helper.rb'
+        copy_file '../../../spec/support/api_shared_examples.rb', './specs/support/api_shared_examples.rb'
+        copy_file '../../../spec/support/crud_shared_examples.rb', './specs/support/crud_shared_examples.rb'
+
+        template 'settings.yml.erb', './config/settings.yml'
+      end
+    end
+  end
+end

data/lib/ditty/helpers/component.rb

@@ -33,11 +33,12 @@ module Ditty
         param :q, String
         param :page, Integer, min: 1, default: 1
         param :sort, String
-        param :order, String, in: %w[asc desc], transform: :downcase, default: 'asc'
+        param :order, String, in: %w[asc desc], transform: :downcase
         # TODO: Can we dynamically validate the search / filter fields?
 
         ds = dataset
         ds = ds.dataset if ds.respond_to?(:dataset)
+        params[:order] ||= 'asc' if params[:sort]
         return ds if params[:count] == 'all'
 
         params[:count] = check_count

data/lib/ditty/helpers/pundit.rb

@@ -12,23 +12,39 @@ module Ditty
         super
       end
 
-      def permitted_attributes(record, action)
-        param_key = PolicyFinder.new(record).param_key
+      def permitted_attributes(record, action = nil)
         policy = policy(record)
+        action ||= record.new? ? :create : :update
         method_name = if policy.respond_to?("permitted_attributes_for_#{action}")
-                        "permitted_attributes_for_#{action}"
-                      else
-                        'permitted_attributes'
-                      end
+          "permitted_attributes_for_#{action}"
+        else
+          'permitted_attributes'
+        end
+        policy.public_send(method_name)
+      end
 
-        policy_fields = policy.public_send(method_name)
+      def permitted_parameters(record, action = nil)
+        param_key = PolicyFinder.new(record).param_key
+        policy_fields = permitted_attributes(record, action)
         request.params.fetch(param_key, {}).select do |key, _value|
           policy_fields.include? key.to_sym
         end
       end
 
+      def permitted_response_attributes(record, method = :values)
+        policy = policy(record)
+        response = record.send(method)
+
+        return response unless policy.respond_to? :response_attributes
+
+        policy_fields = policy.response_attributes
+        response.select do |key, _value|
+          policy_fields.include? key.to_sym
+        end
+      end
+
       def pundit_user
-        current_user
+        current_user unless current_user&.anonymous?
       end
     end
   end

data/lib/ditty/helpers/response.rb

@@ -5,12 +5,12 @@ require 'csv'
 module Ditty
   module Helpers
     module Response
-      def list_response(result)
+      def list_response(result, view: 'index')
         respond_to do |format|
           format.html do
             actions = {}
             actions["#{base_path}/new"] = "New #{heading}" if policy(settings.model_class).create?
-            haml :"#{view_location}/index",
+            haml :"#{view_location}/#{view}",
                  locals: { list: result, title: heading(:list), actions: actions },
                  layout: layout
           end
@@ -18,13 +18,14 @@ module Ditty
             # TODO: Add links defined by actions (New #{heading})
             total = result.respond_to?(:pagination_record_count) ? result.pagination_record_count : result.count
             json(
-              'items' => result.all.map(&:for_json),
+              'items' => result.all.map { |e| permitted_response_attributes(e, :for_json) },
               'page' => (params['page'] || 1).to_i,
               'count' => result.count,
               'total' => total
             )
           end
           format.csv do
+            attachment "#{base_path}.csv"
             CSV.generate do |csv|
               csv << result.first.for_csv.keys
               result.all.each do |r|
@@ -39,18 +40,18 @@ module Ditty
         respond_to do |format|
           format.html do
             flash[:success] = "#{heading} Created"
-            redirect with_layout("#{base_path}/#{entity.id}")
+            redirect with_layout(params[:redirect_to] || flash[:redirect_to] || "#{base_path}/#{entity.display_id}")
           end
           format.json do
             content_type :json
-            redirect "#{base_path}/#{entity.id}", 201
+            redirect "#{base_path}/#{entity.display_id}", 201
           end
         end
       end
 
       def actions(entity = nil)
         actions = {}
-        actions["#{base_path}/#{entity.id}/edit"] = "Edit #{heading}" if entity && policy(entity).update?
+        actions["#{base_path}/#{entity.display_id}/edit"] = "Edit #{heading}" if entity && policy(entity).update?
         actions["#{base_path}/new"] = "New #{heading}" if policy(settings.model_class).create?
         actions
       end
@@ -60,13 +61,15 @@ module Ditty
         respond_to do |format|
           format.html do
             title = heading(:read) + (entity.respond_to?(:name) ? ": #{entity.name}" : '')
+            last_modified entity.updated_at if entity.respond_to?(:updated_at)
+            etag entity.etag if entity.respond_to?(:etag)
             haml :"#{view_location}/display",
                  locals: { entity: entity, title: title, actions: actions },
                  layout: layout
           end
           format.json do
             # TODO: Add links defined by actions (Edit #{heading})
-            json entity.for_json
+            json permitted_response_attributes(entity, :for_json)
           end
           format.csv do
             CSV.generate do |csv|
@@ -82,11 +85,11 @@ module Ditty
           format.html do
             # TODO: Ability to customize the return path and message?
             flash[:success] = "#{heading} Updated"
-            redirect with_layout("#{base_path}/#{entity.id}")
+            redirect with_layout(params[:redirect_to] || flash[:redirect_to] || "#{base_path}/#{entity.display_id}")
           end
           format.json do
-            headers 'Location' => "#{base_path}/#{entity.id}"
-            json body entity.for_json
+            content_type :json
+            redirect "#{base_path}/#{entity.display_id}", 200, json(entity.for_json)
           end
         end
       end
@@ -95,12 +98,11 @@ module Ditty
         respond_to do |format|
           format.html do
             flash[:success] = "#{heading} Deleted"
-            redirect with_layout(base_path.to_s)
+            redirect with_layout(params[:redirect_to] || flash[:redirect_to] || back || base_path)
           end
           format.json do
             content_type :json
-            headers 'Location' => base_path.to_s
-            status 204
+            redirect base_path.to_s, 204
           end
         end
       end

data/lib/ditty/helpers/views.rb

@@ -24,9 +24,11 @@ module Ditty
       def form_control(name, model, opts = {})
         label = opts.delete(:label) || name.to_s.titlecase
         klass = opts.delete(:class) || 'form-control' unless opts[:type] == 'file'
+        klass = "#{klass} is-invalid" if model.errors[name]
         group = opts.delete(:group) || model.class.to_s.demodulize.underscore
         field = opts.delete(:field) || name
         default = opts.delete(:default) || nil
+        help_text = opts.delete(:help_text) || nil
 
         attributes = { type: 'text', id: name, name: "#{group}[#{name}]", class: klass }.merge(opts)
         haml :'partials/form_control', locals: {
@@ -36,7 +38,8 @@ module Ditty
           name: name,
           group: group,
           field: field,
-          default: default
+          default: default,
+          help_text: help_text
         }
       end
 
@@ -47,7 +50,8 @@ module Ditty
         haml :'partials/filter_control', locals: {
           name: filter[:name],
           label: opts[:label] || filter[:name].to_s.titlecase,
-          options: send(meth)
+          options: send(meth),
+          total_filters: opts[:filters]
         }
       end
 
@@ -58,13 +62,13 @@ module Ditty
         messages = flash(key).collect do |message|
           "  <div class='alert alert-#{message[0]} alert-dismissable' role='alert'>#{message[1]}</div>\n"
         end
-        "<div id='#{id}'>\n" + messages.join + '</div>'
+        "<div id='#{id}'>\n#{messages.join}</div>"
       end
 
       def query_string(add = {})
         qs = params.clone.merge(add)
         qs.delete('captures')
-        Rack::Utils.build_query qs
+        Rack::Utils.build_query(qs.delete_if { |_k, v| v == '' })
       end
 
       def delete_form(entity, label = 'Delete')
@@ -90,7 +94,7 @@ module Ditty
       def form_tag(url, options = {}, &block)
         options[:form_verb] ||= :post
         options[:attributes] ||= {}
-        options[:attributes] = { 'class': 'form-horizontal' }.merge options[:attributes]
+        options[:attributes] = { class: 'form-horizontal' }.merge options[:attributes]
         options[:url] = options[:form_verb].to_sym == :get ? url : with_layout(url)
         haml :'partials/form_tag', locals: options.merge(block: block)
       end
@@ -98,7 +102,7 @@ module Ditty
       def pagination(list, base_path, qp = {})
         return unless list.respond_to?(:pagination_record_count) || list.respond_to?(:total_entries)
 
-        list = Ditty::Services::PaginationWrapper.new(list)
+        list = ::Ditty::Services::PaginationWrapper.new(list)
         locals = {
           first_link: "#{base_path}?" + query_string(qp.merge(page: 1)),
           next_link: list.last_page? ? '#' : "#{base_path}?" + query_string(qp.merge(page: list.next_page)),
@@ -134,6 +138,24 @@ module Ditty
           haml_tag :a, name, html_options
         end
       end
+
+      def sort_ui(field)
+        haml :'partials/sort_ui', locals: { field: field }
+      end
+
+      def sort_query(field)
+        query_string(
+          order: params[:sort] == field.to_s && params[:order] == 'asc' ? 'desc' : 'asc',
+          sort: field,
+        )
+      end
+
+      def sort_icon(field)
+        return 'fa-sort' unless params[:sort] == field.to_s
+        return 'fa-sort-up' if params[:order] == 'asc'
+
+        'fa-sort-down'
+      end
     end
   end
 end

data/lib/ditty/listener.rb

@@ -17,7 +17,9 @@ module Ditty
     end
 
     def method_missing(method, *args)
-      return unless args[0].is_a?(Hash) && args[0][:target].is_a?(Sinatra::Base) && args[0][:target].settings.track_actions
+      unless args[0].is_a?(Hash) && args[0][:target].is_a?(Sinatra::Base) && args[0][:target].settings.track_actions
+        return
+      end
 
       log_action(
         user_traits(args[0][:target]).merge(
@@ -64,12 +66,12 @@ module Ditty
     def action_from(target, method)
       return method unless method.to_s.start_with? 'component_'
 
-      target.class.to_s.demodulize.underscore + '_' + method.to_s.gsub(/^component_/, '')
+      "#{target.class.to_s.demodulize.underscore}_#{method.to_s.gsub(/^component_/, '')}"
     end
 
     def log_action(values)
       values[:user] ||= values[:target].current_user if values[:target]
-      @mutex.synchronize { Ditty::AuditLog.create values }
+      @mutex.synchronize { ::Ditty::AuditLog.create values }
     end
 
     def user_traits(target)
@@ -84,4 +86,4 @@ module Ditty
   end
 end
 
-Wisper.subscribe(Ditty::Listener.new) unless ENV['RACK_ENV'] == 'test'
+Wisper.subscribe(::Ditty::Listener.new) unless ENV['RACK_ENV'] == 'test'

data/lib/ditty/memcached.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'ditty/services/logger'
+
+Ditty::Services::Logger.info 'Setting up caching'
+require 'memcached'
+CACHE = Memcached.new(ENV['MEMCACHED_URL'])
+Sequel::Model.plugin :caching, CACHE, ignore_exceptions: true

data/lib/ditty/middleware/accept_extension.rb

@@ -8,7 +8,7 @@ module Ditty
     class AcceptExtension
       attr_reader :env, :regex, :content_type
 
-      def initialize(app, regex = /\A(.*)\.json(\/?)\Z/, content_type = 'application/json')
+      def initialize(app, regex = %r{\A(.*)\.json(/?)\Z}, content_type = 'application/json')
         # @mutex = Mutex.new
         @app = app
         @regex = regex
@@ -19,7 +19,7 @@ module Ditty
         @env = env
 
         request = Rack::Request.new(env)
-        if request.path =~ regex
+        if request.path&.match?(regex)
           request.path_info = request.path_info.gsub(regex, '\1\2')
           env = request.env
           env['ACCEPT'] = content_type

data/lib/ditty/middleware/error_catchall.rb

@@ -16,8 +16,8 @@ module Ditty
         begin
           @app.call env
         rescue StandardError => e
-          ::Ditty::Services::Logger.instance.error "Ditty Catchall: #{e.class}"
-          ::Ditty::Services::Logger.instance.error e
+          ::Ditty::Services::Logger.error "Ditty Catchall: #{e.class}"
+          ::Ditty::Services::Logger.error e
           [500, {}, ['Unknown Error']]
         end
       end

data/lib/ditty/models/base.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'digest/sha2'
 require 'sequel'
 
 module Ditty
@@ -8,6 +9,14 @@ module Ditty
       values
     end
 
+    def display_id
+      self[:slug] || self[:guid] || self[:id]
+    end
+
+    def etag
+      Digest::SHA2.hexdigest values.to_json
+    end
+
     alias for_csv for_json
   end
 end

data/lib/ditty/models/identity.rb

@@ -37,6 +37,10 @@ module Ditty
       }
     end
 
+    def uid
+      user&.id
+    end
+
     # Validation
     def validate
       super
@@ -55,7 +59,7 @@ module Ditty
           # 1 Special Character
           # 1 Number
           # At least 8 characters
-          %r[\A(?=.*[A-Z])(?=.*[a-z])(?=.*[!@#&$*)(}{%^=_+|\\:";'<>,.\-\/?\[\]])(?=.*[0-9]).{8,}\Z],
+          %r[\A(?=.*[A-Z])(?=.*[a-z])(?=.*[!@#&$*)(}{%^=_+|\\:";'<>,.\-/?\[\]])(?=.*[0-9]).{8,}\Z],
           :password,
           message: 'is not strong enough'
         )
@@ -72,12 +76,12 @@ module Ditty
 
     private
 
-    def encrypt_password
-      self.crypted_password = ::BCrypt::Password.create(password)
-    end
+      def encrypt_password
+        self.crypted_password = ::BCrypt::Password.create(password)
+      end
 
-    def password_required
-      crypted_password.blank? || !password.blank?
-    end
+      def password_required
+        crypted_password.blank? || !password.blank?
+      end
   end
 end

data/lib/ditty/models/role.rb

@@ -5,6 +5,7 @@ require 'ditty/models/base'
 module Ditty
   class Role < ::Sequel::Model
     include ::Ditty::Base
+    plugin :tree
 
     many_to_many :users