ditty 0.7.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c15560015979ad1fc7afda1efc7becd871635867ace4fa364f47eb6473baf5e4
-  data.tar.gz: 2ea52af0c53587b08562f5a594b7f0b951638310f60a4c5ce2ce5ac937e2efbd
+  metadata.gz: e785b1b4a84258a46e98753a5de394897bc6d002b88d2fc6629b30b33b52614e
+  data.tar.gz: '094a55847cc4ec09bf1dc9307c9efcffa5b59b498fd407de5950e656e5a5e516'
 SHA512:
-  metadata.gz: 0aa2bd4eb180cf51106d4d645e0effd68a924c866bba915f26526e30d4dfe11d8f800ac32e1779c738e606a39b1a6b003b4039902b43d8a1cde1f2cc2890f9e6
-  data.tar.gz: 39c61fef5b3fad41838de4903b88e16df4b606bd9249421d2db9ede59ed75855f2bc0936aaf84e1a8dc8cce17a0d966520cffaf50196446f91ba20e165ee8b9e
+  metadata.gz: fa7d54c43ac02d1f04a690f2bca5a529b3c65eefa0f287ab44594910bca2b8022656b58e2aef805a52307364481c35be2ba1b1e4b3a97b3450cab1b9acb27d1f
+  data.tar.gz: 847143f0f0d20c67b3451a86e780ec44b914210ceec4498c9218ebc05f7f7277107b1998ca5f273aad0ad1ad45ceb051b81204fe87e6cb91e88ee2ef6af7b49c

data/.env.test

@@ -0,0 +1,2 @@
+CC_TEST_REPORTER_ID=289860573c6284a8e277de86848caba84d840be49e35f3601bcd672ab40d1e35
+DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL=true

data/.gitignore

@@ -14,3 +14,6 @@ vendor
 *.db
 /Gemfile.dev.lock
 migrations
+/gems.*
+.env
+.env.*.local

data/.pryrc

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined?(PryByebug)
   Pry.commands.alias_command 'c', 'continue'
   Pry.commands.alias_command 's', 'step'

data/.rubocop.yml

@@ -1,12 +1,28 @@
-Metrics/LineLength:
+require:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-thread_safety
+  - rubocop-sequel
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7.1
+  Exclude:
+    - migrate/**/*
+Layout/LineLength:
   Max: 120
-
-Style/NumericPredicate:
-  Enabled: false
-
 Layout/LeadingCommentSpace:
   Exclude:
     - 'config.ru'
-
-AllCops:
-  TargetRubyVersion: 2.2
+Layout/EndOfLine:
+  EnforcedStyle: lf
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 2
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+Metrics/MethodLength:
+  CountAsOne: ['array', 'heredoc', 'hash']
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -1,15 +1,11 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.1
-  - 2.4.0
-  - 2.3.3
-  - 2.2.6
+  - 3.0
+  - 2.7
+  - 2.6
 gemfile: Gemfile.ci
 env:
-  global:
-    - CC_TEST_REPORTER_ID=289860573c6284a8e277de86848caba84d840be49e35f3601bcd672ab40d1e35
-    - DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL=true
   matrix:
     - DATABASE_URL="sqlite::memory:" RACK_ENV=test
 before_install:
@@ -21,7 +17,7 @@ before_script:
   - bundle exec rake ditty:prep
 script:
   - bundle exec rake
-  - bundle exec rubocop --fail-level W lib views
+  - bundle exec rubocop --fail-level W lib views spec
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 after_success:

data/CNAME

@@ -0,0 +1 @@
+ditty.io

data/Dockerfile

@@ -0,0 +1,18 @@
+FROM ruby:2.5.3-alpine3.8
+LABEL maintainer: "Sergey Shkarupa <s.shkarupa@gmail.com>"
+
+RUN apk add --no-cache \
+  build-base \
+  less \
+  git \
+  libxml2-dev \
+  libxslt-dev \
+  sqlite-dev \
+  sqlite-doc \
+  sqlite-libs \
+  && gem install bundler:1.17.3
+
+WORKDIR /usr/src/app
+
+COPY . ./
+RUN bundle install --jobs=$(nproc) --no-cache --clean

data/Gemfile.ci

@@ -2,18 +2,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'rubocop'
-gem 'simplecov', '~> 0.13.0'
-gem 'sqlite3'
-
-if RUBY_VERSION < '2.1'
-  gem 'sidekiq', '3.0.0'
-  gem 'activesupport', '<4.0.0'
-  gem 'omniauth', '~>1.4.2'
-elsif RUBY_VERSION < '2.2.0'
-  gem 'sidekiq', '4.0.0'
-  gem 'activesupport', '<5.0.0'
-else
-  gem 'activesupport'
-end

data/Rakefile

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require 'rake'
-require 'bundler/gem_tasks'
-require 'ditty/rake_tasks'
-
 require 'ditty'
-require 'ditty/components/app'
+require 'ditty/components/ditty'
+
+Ditty.component :ditty
 
+Ditty::Components.tasks
+require 'bundler/gem_tasks' if File.exist? 'ditty.gemspec'
 begin
   require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new(:spec)

data/Readme.md

@@ -1,6 +1,7 @@
 [![Build Status](https://travis-ci.org/EagerELK/ditty.svg?branch=master)](https://travis-ci.org/EagerELK/ditty)
 [![Code Climate](https://codeclimate.com/github/EagerELK/ditty/badges/gpa.svg)](https://codeclimate.com/github/EagerELK/ditty)
 [![Test Coverage](https://codeclimate.com/github/EagerELK/ditty/badges/coverage.svg)](https://codeclimate.com/github/EagerELK/ditty/coverage)
+[![Inline docs](http://inch-ci.org/github/EagerELK/ditty.svg?branch=master)](http://inch-ci.org/github/EagerELK/ditty)
 
 # Ditty
 
@@ -33,12 +34,33 @@ gem install ditty
 
 1. Add the components to your rack config file. See the included [`config.ru`](https://github.com/EagerELK/ditty/blob/master/config.ru) file for an example setup
 2. Set the DB connection as the `DATABASE_URL` ENV variable: `DATABASE_URL=sqlite://development.db`
+3. Prepare the Ditty folder: `bundle exec ditty prep`
 3. Run the Ditty migrations: `bundle exec ditty migrate`
 4. Run the Ditty server: `bundle exec ditty server`
 
-## Components
+### Components
 
-The application can now be further extended by creating components.
+The application can now be further extended by creating [components](https://github.com/EagerELK/ditty/wiki/Creating-a-Component).
+
+### Rubocop Cops
+
+Ditty provides a number of [Rubocop](https://github.com/rubocop-hq/rubocop) cops
+to ensure that the Ditty framework is used correctly. Enable this by adding the
+following to your `.rubocop.yml` file:
+
+```yaml
+require: ditty/rubocop
+```
+
+You can run Ditty specific cops as follows:
+
+```bash
+bundle exec rubocop --only Ditty
+```
+
+Adding the `-a` flag to the invocation will automatically fix some of the issues
+for you, but, as always, ensure you have a working copy of your code before
+running this.
 
 ## Development
 

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-architect

data/config.ru

@@ -6,14 +6,14 @@ use Rack::Session::Cookie,
     # :secure=>!TEST_MODE, # Uncomment if only allowing https:// access
     secret: File.read('.session_secret')
 
-require 'ditty/components/app'
-Ditty.component :app
+require 'ditty/components/ditty'
+Ditty.component :ditty
 
 require 'ditty/services/authentication'
 use OmniAuth::Builder do
-  Ditty::Services::Authentication.config.each do |prov, config|
+  ::Ditty::Services::Authentication.config.each do |prov, config|
     provider prov, *config[:arguments]
   end
 end
 
-run Rack::URLMap.new Ditty::Components.routes
+run Rack::URLMap.new ::Ditty::Components.routes

data/ditty.gemspec

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ditty/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'ditty'
-  spec.version       = Ditty::VERSION
+  spec.version       = ::Ditty::VERSION
   spec.authors       = ['Jurgens du Toit']
   spec.email         = ['jrgns@jadeit.co.za']
 
@@ -15,38 +15,49 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/eagerelk/ditty'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0") #.reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = ['ditty']
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'bundler', '>= 1'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'database_cleaner', '~> 1.0'
   spec.add_development_dependency 'factory_bot'
-  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'faker'
   spec.add_development_dependency 'racksh'
+  spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop-sequel'
+  spec.add_development_dependency 'rubocop-thread_safety'
+  spec.add_development_dependency 'simplecov', '~> 0.13.0'
+  spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'timecop'
 
-  spec.add_dependency 'activesupport', '>= 3'
-  spec.add_dependency 'bcrypt', '~> 3.1'
-  spec.add_dependency 'haml', '~> 5.0'
-  spec.add_dependency 'logger', '~> 1.0'
-  spec.add_dependency 'oga', '>= 2.14'
+  spec.add_dependency 'activesupport', '>= 6'
+  spec.add_dependency 'bcrypt', '>= 3.1'
+  spec.add_dependency 'browser', '>= 5.3'
+  spec.add_dependency 'dotenv', '>= 2'
+  spec.add_dependency 'haml', '>= 5.1.2'
+  spec.add_dependency 'logger', '>= 1.0'
   spec.add_dependency 'mail', '>= 1.7'
+  spec.add_dependency 'oga', '>= 2.14'
   spec.add_dependency 'omniauth', '~> 1.0'
   spec.add_dependency 'omniauth-identity', '~> 1.0'
   spec.add_dependency 'pundit', '~> 1.0'
-  spec.add_dependency 'rack-contrib', '~> 1.0'
-  spec.add_dependency 'rack_csrf', '~> 1.0'
-  spec.add_dependency 'rake', '~> 12.0'
-  spec.add_dependency 'sequel', '>= 4.0'
-  spec.add_dependency 'sinatra', '>= 2.0'
-  spec.add_dependency 'sinatra-contrib', '~> 2.0'
-  spec.add_dependency 'sinatra-flash', '~> 0.3'
-  spec.add_dependency 'sinatra-param', '~> 1.5'
-  spec.add_dependency 'tilt', '>= 2'
+  spec.add_dependency 'rack-contrib', '>= 2.0'
+  spec.add_dependency 'rack_csrf', '>= 2.0'
+  spec.add_dependency 'rake', '>= 13.0'
+  spec.add_dependency 'sequel', '>= 5.0'
+  spec.add_dependency 'sinatra', '>= 2.1'
+  spec.add_dependency 'sinatra-contrib', '>= 2.0'
+  spec.add_dependency 'sinatra-flash', '>= 0.3'
+  spec.add_dependency 'sinatra-param', '>= 1.6'
   spec.add_dependency 'thor', '>= 0.20'
+  spec.add_dependency 'tilt', '>= 2'
   spec.add_dependency 'will_paginate', '>= 3.1'
   spec.add_dependency 'wisper', '~> 2.0'
 end

data/docs/CNAME

@@ -0,0 +1 @@
+ditty.io

data/docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-architect

data/docs/index.md

@@ -0,0 +1,34 @@
+# Ditty.io
+
+Ditty is a Web Application Framework built on top of the [Sinatra](http://sinatrarb.com/) framework.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'ditty'
+gem 'sqlite3'
+```
+
+You can replace `sqlite3` with a DB adapter of your choice.
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install ditty
+```
+
+## Usage
+
+1. Add the components to your rack config file. See the included [`config.ru`](https://github.com/EagerELK/ditty/blob/master/config.ru) file for an example setup
+2. Set the DB connection as the `DATABASE_URL` ENV variable: `DATABASE_URL=sqlite://development.db`
+3. Prepare the Ditty folder: `bundle exec ditty prep`
+3. Run the Ditty migrations: `bundle exec ditty migrate`
+4. Run the Ditty server: `bundle exec ditty server`

data/exe/ditty

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'ditty/cli'
 
 Ditty::CLI.start

data/lib/ditty.rb

@@ -6,6 +6,8 @@ require 'ditty/services/logger'
 module Ditty
   class ComponentError < StandardError; end
 
+  class TemplateNotFoundError < StandardError; end
+
   # A thread safe cache class, offering only #[] and #[]= methods,
   # each protected by a mutex.
   # Ripped off from Roda - https://github.com/jeremyevans/roda
@@ -30,6 +32,10 @@ module Ditty
       @mutex.synchronize { @hash.map(&block) }
     end
 
+    def each(&block)
+      @mutex.synchronize { @hash.each(&block) }
+    end
+
     def inject(memo, &block)
       @mutex.synchronize { @hash.inject(memo, &block) }
     end
@@ -37,6 +43,10 @@ module Ditty
     def each_with_object(memo, &block)
       @mutex.synchronize { @hash.each_with_object(memo, &block) }
     end
+
+    def key?(key)
+      @hash.key? key
+    end
   end
 
   # Ripped off from Roda - https://github.com/jeremyevans/roda
@@ -52,17 +62,23 @@ module Ditty
       h = @components
       unless (component = h[name])
         require "ditty/components/#{name}"
-        raise ComponentError, "Component #{name} did not register itself correctly in Ditty::Components" unless (component = h[name])
+        unless (component = h[name])
+          raise ComponentError, "Component #{name} did not register itself correctly in Ditty::Components"
+        end
       end
       component
     end
 
+    def self.component?(name)
+      @components.key? name
+    end
+
     # Register the given component with Component, so that it can be loaded using #component
     # with a symbol. Should be used by component files. Example:
     #
     #   Ditty::Components.register_component(:component_name, ComponentModule)
     def self.register_component(name, mod)
-      Ditty::Services::Logger.instance.info "Registering #{mod} as #{name}"
+      ::Ditty::Services::Logger.info "Registering #{mod} as #{name}"
       @components[name] = mod
     end
 
@@ -80,9 +96,9 @@ module Ditty
 
     # Return an ordered list of navigation items:
     # `[{order:0, link:'/users/', text:'Users'}, {order:1, link:'/roles/', text:'Roles'}]
-    def self.navigation
+    def self.navigation(request)
       nav = components.each_with_object([]) do |comp, memo|
-        memo.concat comp[1].navigation if comp[1].respond_to?(:navigation)
+        memo.concat comp[1].navigation(request) if comp[1].respond_to?(:navigation)
       end
       nav.sort_by { |v| v[:order] }
     end
@@ -111,6 +127,15 @@ module Ditty
       end
     end
 
+    def self.tasks
+      require 'rake'
+      require 'rake/tasklib'
+      require 'ditty/db' unless defined? DB
+      components.each do |_name, comp|
+        comp.tasks if comp.respond_to?(:tasks)
+      end
+    end
+
     module Base
       module ClassMethods
         # Load a new component into the current class.  A component can be a module
@@ -121,6 +146,7 @@ module Ditty
         #   Component.component :csrf
         def component(component, *args, &block)
           raise ComponentError, 'Cannot add a component to a frozen Component class' if frozen?
+
           component = Components.load_component(component) if component.is_a?(Symbol)
           include(component::InstanceMethods) if defined?(component::InstanceMethods)
           extend(component::ClassMethods) if defined?(component::ClassMethods)