eucalypt 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fe72a6f8a63096db282ff0c7eebbd6719860893cd6dd99eb4c91a3d7cc163de
-  data.tar.gz: 31c406116e711ebb9b5a94deaaaa909a560fa58cb78146ca1f4781205c5f669b
+  metadata.gz: e520c9680993730a49c3ec87c04f358ea17607420dce59d11b03dbcfb34c67a0
+  data.tar.gz: d20522c6f917515fe8762a6cdb72608d886fb7a0b1d8913f54b16f07da07d91a
 SHA512:
-  metadata.gz: c1540c989e1c0774ef637782e65b433f3ee9d66ba9d6c350da7ffa98bfcd05046d1cf32a2c91ac6f7567ba82daa639866116e6239b7b5344225a542c09cf974b
-  data.tar.gz: 042fd7143d19081383fd014f2f55504f01d37e404e08f797abf3830da606a878d531ea160ac98d0f32ffe394613894345b1f1174399ad422e3a482c3ccfd18ee
+  metadata.gz: 4f68cde88435a9368929ab30006c9248c131fc276286cfd42068b6dc52632feb8b952fefce41da41167c76b1c3c6b545968eb13bf5012c9adb32340d69428e6f
+  data.tar.gz: af70583560eadded293d15c7cea6f390d75494709d4ece3e6cb57232677eb34a2e7aa634202772c65c18e8cb3057ba253fc643913876bdee8384d590829e6ec1

data/README.md

@@ -30,9 +30,9 @@ $ eucalypt init my-new-app
 
 Move into your new application's directory and run the top-level `eucalypt` command to display a list of all available commands.
 
-## Documentation and help
+## Documentation
 
-The full documentation can be found [here](https://eucalypt.gitbook.io/eucalypt).
+The full documentation of the CLI and micro-framework can be found [here](https://eucalypt.gitbook.io/eucalypt).
 
 ## Features
 

data/lib/eucalypt/eucalypt-blog/namespaces/blog/cli/blog.rb

@@ -11,8 +11,8 @@ module Eucalypt
     include Eucalypt::Helpers::Gemfile
     using Colorize
 
-    method_option :route, type: :string, aliases: '-r', default: 'blog', desc: "The route at which the blog lies"
-    desc "setup", "Sets up the blog-aware environment".colorize(:grey)
+    option :route, type: :string, aliases: '-r', default: 'blog', desc: "The route at which the blog lies"
+    desc "setup", "Sets up the blog environment".colorize(:grey)
     def setup
       directory = File.expand_path('.')
       if Eucalypt.app? directory

data/lib/eucalypt/eucalypt-blog/namespaces/blog-article/cli/article.rb

@@ -13,12 +13,12 @@ module Eucalypt
     include Eucalypt::Blog::Helpers
     using Colorize
 
-    method_option :descending, type: :boolean, aliases: '-d', default: true, desc: 'Descending chronological order'
-    method_option :ascending, type: :boolean, aliases: '-a', default: false, desc: 'Ascending chronological order'
-    method_option :tag, type: :string, aliases: '-t', default: String.new, desc: 'Search by blog article tag'
-    method_option :year, type: :string, aliases: '-Y', desc: 'Search articles by year'
-    method_option :month, type: :string, aliases: '-M', desc: 'Search articles by month'
-    method_option :day, type: :string, aliases: '-D', desc: 'Search articles by day'
+    option :descending, type: :boolean, aliases: '-d', default: true, desc: 'Descending chronological order'
+    option :ascending, type: :boolean, aliases: '-a', default: false, desc: 'Ascending chronological order'
+    option :tag, type: :string, aliases: '-t', default: String.new, desc: 'Search by blog article tag'
+    option :year, type: :string, aliases: '-Y', desc: 'Search articles by year'
+    option :month, type: :string, aliases: '-M', desc: 'Search articles by month'
+    option :day, type: :string, aliases: '-D', desc: 'Search articles by day'
     desc "list", "Display the metadata of blog articles".colorize(:grey)
     def list
       directory = File.expand_path('.')

data/lib/eucalypt/eucalypt-core/cli/init.rb

@@ -5,13 +5,13 @@ module Eucalypt
     include Eucalypt::Helpers::Messages
     using String::Builder
     using Colorize
-    method_option :git, type: :boolean, default: true, desc: 'Initialize a Git repository'
-    method_option :bundle, type: :boolean, default: true, desc: 'Install gems after application generation'
-    method_option :blog, type: :boolean, default: false, aliases: '-b', desc: 'Set up the blog environment'
-    method_option :route, type: :string, default: 'blog', aliases: '-r', desc: 'Specify a route for the blog application'
-    method_option :silence, type: :boolean, default: false, aliases: '-s', desc: 'Silence `git init` and `bundle install` commands'
-    method_option :warden, type: :boolean, default: false, aliases: '-w', desc: 'Set up Warden authentication'
-    method_option :pundit, type: :boolean, default: false, aliases: '-p', desc: 'Set up Pundit authorization'
+    option :git, type: :boolean, default: true, desc: 'Initialize a Git repository'
+    option :bundle, type: :boolean, default: true, desc: 'Install gems after application generation'
+    option :blog, type: :boolean, default: false, aliases: '-b', desc: 'Set up the blog environment'
+    option :route, type: :string, default: 'blog', aliases: '-r', desc: 'Specify a route for the blog application'
+    option :silence, type: :boolean, default: false, aliases: '-s', desc: 'Silence `git init` and `bundle install` commands'
+    option :warden, type: :boolean, default: false, aliases: '-w', desc: 'Set up Warden authentication'
+    option :pundit, type: :boolean, default: false, aliases: '-p', desc: 'Set up Pundit authorization'
     desc "init [NAME]", "Sets up your application".colorize(:grey)
     def init(name)
       current_directory = File.expand_path ?.

data/lib/eucalypt/eucalypt-core/cli/launch.rb

@@ -3,11 +3,11 @@ module Eucalypt
   class CLI < Thor
     using Colorize
     include Eucalypt::Helpers::Messages
-    method_option :port, type: :numeric, aliases: '-p', desc: 'Port to serve the application on'
-    method_option :rerun, type: :boolean, aliases: '-r', desc: 'Rerun (watch for file changes and restart server)'
-    method_option :quiet, type: :boolean, aliases: '-q', desc: 'Silences rerun (runs less verbosely)'
+    option :port, type: :numeric, aliases: '-p', desc: 'Port to serve the application on'
+    option :rerun, type: :boolean, aliases: '-r', desc: 'Rerun (watch for file changes and restart server)'
+    option :quiet, type: :boolean, aliases: '-q', desc: 'Silences rerun (runs less verbosely)'
     desc "launch [ENV]", "Launches your application".colorize(:grey)
-    def launch(env = ENV['RACK_ENV']||'development')
+    def launch(env = ENV['APP_ENV']||'development')
       directory = File.expand_path('.')
       if Eucalypt.app? directory
         unless %w[p production d development t test].include? env
@@ -26,7 +26,7 @@ module Eucalypt
 
         puts "Running command: #{cmd.colorize(:bold)}"
         puts "Rack environment: #{env.colorize(:bold)}"
-        exec "env RACK_ENV=#{env} #{cmd}"
+        exec "env APP_ENV=#{env} #{cmd}"
       else
         Eucalypt::Error.wrong_directory
       end

data/lib/eucalypt/eucalypt-core/cli/test.rb

@@ -2,7 +2,7 @@ require_relative '__base__'
 module Eucalypt
   class CLI < Thor
     using Colorize
-    method_option :summarized, type: :boolean, default: false, aliases: '-s', desc: 'rspec -fd spec'
+    option :summarized, type: :boolean, default: false, aliases: '-s', desc: 'rspec -fd spec'
     desc "test", "Run all application tests".colorize(:grey)
     def test
       directory = File.expand_path('.')

data/lib/eucalypt/eucalypt-core/templates/eucalypt/config/logging.rb

@@ -1,22 +1,24 @@
 class ApplicationController < Sinatra::Base
   set :logger, Lumberjack::Logger.new
 
-  configure :production do
-    require 'fileutils'
-    use Rack::CommonLogger, $stdout
+  require 'fileutils'
+  %i[production test].each do |environment|
+    configure environment do
+      use Rack::CommonLogger, $stdout
 
-    log_path = Eucalypt.path 'log', Time.now.strftime("%Y-%m-%dT%H-%M-%S_%z").sub(/_\+/, ?p).sub(/_\-/, ?m)
-    FileUtils.mkdir_p log_path
+      log_path = Eucalypt.path 'log', Time.now.strftime("%Y-%m-%dT%H-%M-%S_%z").sub(/_\+/, ?p).sub(/_\-/, ?m)
+      FileUtils.mkdir_p log_path
 
-    # STDERR logger
-    stderr_log = File.new File.join(log_path, 'stderr.log'), 'a+'
-    $stderr.reopen stderr_log
-    $stderr.sync = true
+      # STDERR logger
+      stderr_log = File.new File.join(log_path, "#{settings.environment}.stderr.log"), 'a+'
+      $stderr.reopen stderr_log
+      $stderr.sync = true
 
-    # STDOUT logger
-    stdout_log = File.new File.join(log_path, 'stdout.log'), 'a+'
-    $stdout.reopen stdout_log
-    $stdout.sync = true
+      # STDOUT logger
+      stdout_log = File.new File.join(log_path, "#{settings.environment}.stdout.log"), 'a+'
+      $stdout.reopen stdout_log
+      $stdout.sync = true
+    end
   end
 
   helpers do

data/lib/eucalypt/eucalypt-core/templates/eucalypt/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require './app'
 Bundler.require :test
 
-ENV['RACK_ENV'] = 'test'
+ENV['APP_ENV'] = 'test'
 
 Shoulda::Matchers.configure do |config|
   config.integrate do |with|

data/lib/eucalypt/eucalypt-generate/namespaces/generate/cli/generate-scaffold.rb

@@ -10,6 +10,7 @@ module Eucalypt
     option :no, aliases: '-n', type: :array, default: [], enum: %w[m ms c cs h hs], desc: "Omit specified scaffold files"
     option :rest, aliases: '-r', type: :boolean, default: false,  desc: "Generate REST routes for the controller"
     option :policy, aliases: '-p', type: :boolean, default: false, desc: "Generate a policy with the scaffold"
+    option :headless, type: :boolean, aliases: '-H', default: false, desc: "Policy with no associated model"
     option :table, type: :boolean, default: true, desc: "Generate a table migration"
     desc "scaffold [NAME] *[COLUMN∶TYPE]", "Generates a scaffold".colorize(:grey)
     def scaffold(name, *columns)
@@ -40,17 +41,20 @@ module Eucalypt
           controller = Eucalypt::Generators::Controller.new
           controller.destination_root = directory
           policy = options[:rest] && options[:policy]
+          headless = options[:policy] && options[:headless]
           controller.generate(
             name: name,
             spec: controller_spec,
             rest: options[:rest],
-            policy: policy
+            policy: policy,
+            headless: headless
           )
         end
 
         if options[:policy]
           args = ['security', 'policy', 'generate', name]
-          args << %w[-p create edit delete] if options[:rest]
+          args << '--headless' if options[:headless]
+          args << %w[-p add edit delete] if options[:rest]
           args.flatten!
           Eucalypt::CLI.start(args)
         end

data/lib/eucalypt/eucalypt-generate/namespaces/generate-controller/cli/generate-controller.rb

@@ -19,7 +19,8 @@ module Eucalypt
           name: name,
           spec: options[:spec],
           rest: options[:rest],
-          policy: false
+          policy: false,
+          headless: false
         )
       else
         Eucalypt::Error.wrong_directory

data/lib/eucalypt/eucalypt-generate/namespaces/generate-controller/generators/controller.rb

@@ -14,7 +14,7 @@ module Eucalypt
         File.join File.dirname(__dir__), 'templates'
       end
 
-      def generate(spec: true, rest: false, policy: false, name:)
+      def generate(spec: true, rest: false, policy: false, headless: false, name:)
         controller = Inflect.new(:controller, name)
 
         route = '/' << (rest ? controller.route_name.pluralize : controller.route_name)
@@ -34,7 +34,8 @@ module Eucalypt
           class_name: controller.class_name,
           helper_class_name: helper.class_name,
           resource: controller.resource,
-          resources: controller.resources
+          resources: controller.resources,
+          headless: headless
         }
 
         template(controller_template, controller.file_path, config)

data/lib/eucalypt/eucalypt-generate/namespaces/generate-controller/templates/controller/policy_rest_controller.tt

@@ -1,17 +1,24 @@
 class <%= config[:class_name] %> < Eucalypt::Controller(route: '<%= config[:route] %>')
   helpers <%= config[:helper_class_name] %> if defined? <%= config[:helper_class_name] %>
 
-  # You can use the `current_user` helper provided by Warden in your views.
+  # You can use the following authentication helper methods in your views:
+  # `current_user` - The User model object for the current user.
+  # `authenticated?` (alias `logged_in?`) - Whether or not a user is logged in.
 
-  # You can also use authorization helpers provided by Pundit in your views.
+  # You can also use authorization helpers in your views.
   # These are useful for conditional displays to users with the correct permissions.
   # - e.g. Showing a form for editing <%= config[:resources] %>
-
-  # Pundit authorization helpers are used in the following way:
-  # - `policy(<%= config[:constant] %>).add?`
-  # - `policy(<%= config[:constant] %>).edit?`
-  # - `policy(<%= config[:constant] %>).delete?`
-
+  <% if config[:headless] %>
+  # Authorization helpers are used in the following way (if using headless policies):
+  # - `authorized?(:<%= config[:resource] %>, :add?)`
+  # - `authorized?(:<%= config[:resource] %>, :edit?)`
+  # - `authorized?(:<%= config[:resource] %>, :delete?)`
+  <% else %>
+  # Authorization helpers are used in the following way:
+  # - `authorized?(<%= config[:constant] %>, :add?)`
+  # - `authorized?(<%= config[:constant] %>, :edit?)`
+  # - `authorized?(<%= config[:constant] %>, :delete?)`
+  <% end %>
   # GET - Browse
   get '/' do
     @<%= config[:resources] %> = <%= config[:constant] %>.all

data/lib/eucalypt/eucalypt-security/namespaces/security-policy/cli/security-policy.rb

@@ -11,7 +11,8 @@ module Eucalypt
     include Eucalypt::Helpers
     using Colorize
 
-    method_option :permissions, type: :array, aliases: '-p', default: [], desc: "Permissions to generate along with the policy"
+    option :headless, type: :boolean, aliases: '-H', default: false, desc: "Policy with no associated model"
+    option :permissions, type: :array, aliases: '-p', default: [], desc: "Permissions to generate along with the policy"
     desc "generate [NAME]", "Create a new Pundit policy".colorize(:grey)
     def generate(name)
       directory = File.expand_path('.')
@@ -37,7 +38,7 @@ module Eucalypt
         policy_generator.destination_root = directory
 
         # Generate policy file
-        policy_generator.generate(name: name)
+        policy_generator.generate(headless: options[:headless], name: name)
 
         # Create policy roles table
         policy_generator.generate_policy_roles_migration(policy: policy.resource)

data/lib/eucalypt/eucalypt-security/namespaces/security-policy/generators/policy.rb

@@ -13,9 +13,9 @@ module Eucalypt
         File.join File.dirname(__dir__), 'templates'
       end
 
-      def generate(name:)
+      def generate(headless:, name:)
         policy = Inflect.new(:policy, name)
-        config = {class_name: policy.class_name, resource: policy.resource, constant: policy.constant}
+        config = {class_name: policy.class_name, resource: policy.resource, constant: policy.constant, headless: headless}
         template('policy.tt', policy.file_path, config)
       end
 

data/lib/eucalypt/eucalypt-security/namespaces/security-policy/templates/policy.tt

@@ -1,4 +1,4 @@
-class <%= config[:class_name] %>
+class <%= config[:class_name] %><%= " < Struct.new(:user, :#{config[:resource]})" if config[:headless] %>
   attr_reader :user, :<%= config[:resource] %>
 
   def initialize(user, <%= config[:resource] %>)

data/lib/eucalypt/eucalypt-security/namespaces/security-pundit/templates/pundit.tt

@@ -1,4 +1,11 @@
 class ApplicationController < Sinatra::Base
   # Include Pundit for authorization
   include Pundit
+
+  helpers do
+    def authorized?(policy, permission)
+      return false unless authenticated?
+      policy(policy).send permission
+    end
+  end
 end

data/lib/eucalypt/eucalypt-security/namespaces/security-warden/templates/auth_controller.tt

@@ -2,12 +2,12 @@ class AuthenticationController < Eucalypt::Controller(route: '/auth')
   helpers AuthenticationHelper if defined? AuthenticationHelper
 
   get '/login' do
-    redirect '/' if current_user
+    redirect '/' if authenticated?
     erb :'authentication/login', layout: false
   end
 
   post '/login' do
-    redirect '/' if current_user
+    redirect '/' if authenticated?
     authenticate
     redirect session[:return_to] || '/'
   end

data/lib/eucalypt/eucalypt-security/namespaces/security-warden/templates/warden.tt

@@ -28,8 +28,14 @@ class ApplicationController < Sinatra::Base
       env['warden'].user
     end
 
+    def authenticated?
+      !!current_user
+    end
+
     def authenticate
       env['warden'].authenticate!
     end
+
+    alias_method :logged_in?, :authenticated?
   end
 end

data/lib/eucalypt/version.rb

@@ -1,3 +1,3 @@
 module Eucalypt
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eucalypt
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Edwin Onuonga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler