katapult 0.1.2 → 0.2.0

data/lib/generators/katapult/haml/templates/index.html.haml

@@ -17,7 +17,7 @@
         %td
           .items__actions
             = link_to 'Edit', <%= wui.path(:edit, object_name) %>, class: 'items__action'
-            = link_to 'Destroy', <%= wui.path(:destroy, object_name) %>, method: :delete, class: 'items__action', confirm: 'Really destroy?'
+            = link_to 'Destroy', <%= wui.path(:destroy, object_name) %>, method: :delete, class: 'items__action', data: { confirm: 'Really destroy?' }, title: "Destroy #{<%= object_name %>.to_s}"
           <%- wui.custom_actions.select(&:member?).each do |action| -%>
             = link_to '<%= action.name.humanize.titleize %>', <%= wui.path(action, object_name) %>, class: 'items__action'<%=
                 ", method: :#{action.method}" unless action.get?

data/lib/generators/katapult/haml/templates/show.html.haml

@@ -12,7 +12,7 @@
 <% end -%>
 
 %dl.values
-<% wui.model.attrs.each do |attribute| -%>
+<% wui.model.renderable_attrs.each do |attribute| -%>
   <%- model_attribute = "#{model_name(:ivar)}.#{attribute.name}" -%>
   %dt
     = <%= model_name(:class) %>.human_attribute_name(:<%= attribute.name %>)
@@ -31,11 +31,9 @@
     €
   <%- when :text -%>
     = simple_format(<%= model_attribute %>)
-  <%- when :markdown -%>
-    = markdown(<%= model_attribute %>)
   <%- when :flag -%>
     = <%= model_attribute %> ? 'Yes' : 'No'
   <%- when :datetime -%>
-    = l(<%= model_attribute %>) if <%= model_attribute %>
+    = l(<%= model_attribute %>.to_date) if <%= model_attribute %>
   <%- end -%>
 <%- end -%>

data/lib/generators/katapult/install/templates/lib/katapult/application_model.rb

@@ -1,18 +1,20 @@
 # Here you define the fundamentals of your application.
 #
 # Add a model:
-# model 'customer' do |customer|
-#   customer.attr :name
-#   customer.attr :birth, type: :date
-#   customer.attr :email
+# model 'user' do |user|
+#   user.attr :name
+#   user.attr :birth, type: :datetime
+#   user.attr :email
 # end
 #
 # Add a web user interface:
-# wui 'customer' do |wui|
-#   wui.action :index
-#   wui.action :show
+# wui 'user' do |wui|
+#   wui.crud # Creates all CRUD actions: index, new, show, etc.
 #   wui.action :lock, scope: :member, method: :post
 # end
 #
 # Add navigation
 # navigation :main
+#
+# Add authentication
+# authenticate 'user', system_email: 'system@example.com'

data/lib/generators/katapult/model/model_generator.rb

@@ -15,7 +15,7 @@ module Katapult
 
       def create_migration_file
         migration_name = "create_#{table_name}"
-        migration_attributes = model.attrs.map(&:for_migration)
+        migration_attributes = model.db_fields.map(&:for_migration)
 
         args = [migration_name] + migration_attributes
         options = { timestamps: true, force: true }

data/lib/generators/katapult/w_u_i/templates/controller.rb

@@ -91,7 +91,7 @@ class <%= model_name(:classes) %>Controller < ApplicationController
 
   def <%= method_name(:params) %>
     <%= method_name(:params) %> = params[:<%= model_name(:variable) %>]
-    <%= method_name(:params) %> ? <%= method_name(:params) %>.permit(<%= wui.model.attrs.map(&:name).map(&:to_sym) %>) : {}
+    <%= method_name(:params) %> ? <%= method_name(:params) %>.permit(%i[<%= wui.model.attrs.map(&:name).join(' ') %>]) : {}
   end
 
   def <%= method_name(:scope) %>

data/lib/generators/katapult/w_u_i/w_u_i_generator.rb

@@ -21,14 +21,16 @@ module Katapult
         route = model_name(:symbols)
         routes = File.read('config/routes.rb')
 
-        if routes.include? "resources #{ route }"
+        if routes =~ /^\s+resources #{ route }/
           say_status :warn, <<MESSAGE, :red
 Routes for #{ route } already exist! Not updated.
 
 In order to keep existing routes created by the user, the config/routes.rb file
-is not wiped on model transformation. To have Katapult update the #{ route}
+is not wiped on model transformation. To have Katapult update the #{ route }
 route for you, delete it before transforming the application model.
 MESSAGE
+        elsif wui.crud_only?
+          route "resources #{ route }"
         else
           route render_partial('_route.rb')
         end

data/lib/katapult/application_model.rb

@@ -3,7 +3,7 @@
 module Katapult
   class ApplicationModel
 
-    attr_reader :models, :wuis, :navigation
+    attr_reader :models, :wuis, :navigation, :authentication
 
     def initialize
       @models = []
@@ -33,12 +33,19 @@ module Katapult
       @navigation = navigation
     end
 
+    def set_authentication(auth)
+      auth.set_application_model(self)
+      auth.ensure_user_model_attributes_present
+      @authentication = auth
+    end
+
     # ---
 
     def render
       models.each &:render
       wuis.each &:render
       navigation.render if navigation
+      authentication.render if authentication
     end
 
   end

data/lib/katapult/attribute.rb

@@ -8,16 +8,17 @@ require 'zlib'
 module Katapult
   class Attribute < Element
 
-    options :type, :default, :assignable_values, :allow_blank
+    options :type, :default, :assignable_values, :allow_blank, :skip_db
 
     UnknownTypeError = Class.new(StandardError)
     MissingOptionError = Class.new(StandardError)
-    TYPES = %i(string email url integer money text markdown flag datetime)
+    TYPES = %i(string email password url integer money text flag datetime json plain_json)
 
     def initialize(*args)
       super
 
       self.type ||= :email if name.to_s =~ /email/
+      self.type ||= :password if name.to_s =~ /password/
       self.type ||= :string
 
       validate
@@ -31,15 +32,12 @@ module Katapult
 
     def for_migration
       db_type = case type
-      when :email, :url
-        'string'
-      when :flag
-        'boolean'
-      when :money
-        'decimal{10,2}' # {precision,scale} = total digits, decimal places
-      else
-        type
-      end
+      when :email, :url, :password then 'string'
+      when :flag then 'boolean'
+      when :money then 'decimal{10,2}' # {precision,scale} = total digits, decimal places
+      when :json then 'jsonb' # Indexable JSON
+      when :plain_json then 'json' # Only use this if you need to
+      else type end
 
       "#{name}:#{db_type}"
     end
@@ -51,6 +49,7 @@ module Katapult
       else
         case type
         when :string     then "#{name}-string"
+        when :password   then "#{name}-password"
         when :email      then "#{name}@example.com"
         when :url        then "#{name}.example.com"
         when :text       then "#{name}-text"

data/lib/katapult/authentication.rb

@@ -0,0 +1,25 @@
+require 'generators/katapult/clearance/clearance_generator'
+
+module Katapult
+  class Authentication < Element
+
+    MissingUserModel = Class.new(StandardError)
+
+    # attr name: The user model name
+    attr_accessor :system_email
+
+    def ensure_user_model_attributes_present
+      user_model = application_model.get_model(name) or raise MissingUserModel,
+        "Could not find a model named #{ name }"
+      user_attrs = user_model.attrs.map(&:name)
+
+      user_model.attr(:email) unless user_attrs.include?('email')
+      user_model.attr(:password, type: :password, skip_db: true) unless user_attrs.include?('password')
+    end
+
+    def render
+      Generators::ClearanceGenerator.new(self).invoke_all
+    end
+
+  end
+end

data/lib/katapult/binary_util.rb

@@ -0,0 +1,37 @@
+# Utility methods.
+
+# The Katapult::Util module is used inside the `katapult` script. It should not
+# require any gems in order to prevent version conflicts.
+require_relative '../katapult'
+require 'bundler'
+
+module Katapult
+  module BinaryUtil
+    extend self
+
+    def git_commit(message, options = nil)
+      message.gsub! /'/, "" # remove single quotes
+      system "git add --all; git commit -m '#{ message }' --author='katapult <katapult@makandra.com>' #{ options }"
+    end
+
+    def create_rails_app(name)
+      run "rails _#{ Katapult::RAILS_VERSION }_ new #{ name } --skip-test-unit --skip-bundle --database postgresql"
+    end
+
+    def puts(*args)
+      message = "\n> #{ args.join ' ' }"
+      Kernel.puts "\e[35m#{ message }\e[0m" # pink
+    end
+
+    # With clean Bundler env
+    def run(command)
+      success = Bundler.with_clean_env { system command }
+
+      if !success
+        puts 'x Something went wrong'
+        exit(1)
+      end
+    end
+
+  end
+end

data/lib/katapult/element.rb

@@ -33,8 +33,8 @@ module Katapult
     end
 
     def name(kind = nil)
-      human_name = @name.downcase
       machine_name = @name.underscore
+      human_name = machine_name.humanize.downcase
 
       case kind.to_s
       when ''          then @name

data/lib/katapult/generator.rb

@@ -24,5 +24,11 @@ module Katapult
       ERB.new(::File.binread(path), nil, '%').result(given_binding || binding)
     end
 
+    def run(*)
+      Bundler.with_clean_env do
+        super
+      end
+    end
+
   end
 end

data/lib/katapult/model.rb

@@ -22,7 +22,19 @@ module Katapult
     end
 
     def label_attr
-      attrs.first
+      renderable_attrs.first
+    end
+
+    def db_fields
+      attrs.reject(&:skip_db)
+    end
+
+    def renderable_attrs
+      attrs.reject { |a| %w[plain_json json password].include? a.type.to_s }
+    end
+
+    def editable_attrs
+      attrs.reject { |a| %w[plain_json json].include? a.type.to_s }
     end
 
     def render

data/lib/katapult/parser.rb

@@ -5,6 +5,7 @@ require_relative 'application_model'
 require 'katapult/model'
 require 'katapult/wui'
 require 'katapult/navigation'
+require 'katapult/authentication'
 
 module Katapult
   class Parser
@@ -31,6 +32,12 @@ module Katapult
       application_model.set_navigation Navigation.new(name)
     end
 
+    def authenticate(name, system_email:)
+      application_model.set_authentication Authentication.new(name,
+        system_email: system_email
+      )
+    end
+
     private
 
     attr_accessor :application_model

data/lib/katapult/version.rb

@@ -1,3 +1,3 @@
 module Katapult
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/katapult/wui.rb

@@ -34,6 +34,10 @@ module Katapult
       %i(index show create update destroy).each &method(:action)
     end
 
+    def crud_only?
+      actions.map(&:name).sort == RAILS_ACTIONS.sort
+    end
+
     def model
       model_name = @model || self.name
       application_model.get_model(model_name) or raise UnknownModelError,

data/lib/katapult.rb

@@ -2,4 +2,6 @@ require 'active_support'
 require 'active_support/core_ext/hash/slice'
 
 module Katapult
+  RAILS_VERSION = '4.2.6'
+  RUBY_VERSION = '2.3.0'
 end

data/spec/attribute_spec.rb

@@ -32,6 +32,19 @@ describe Katapult::Attribute do
     end
   end
 
+  describe 'password attributes' do
+    it 'recognizes password attributes' do
+      expect(described_class.new('password').type).to eql(:password)
+      expect(described_class.new('encrypted_password').type).to eql(:password)
+      expect(described_class.new('name').type).to_not eql(:password)
+    end
+
+    it 'does not overwrite a given type' do
+      expect(described_class.new('password', type: :string).type).to eql(:string)
+      expect(described_class.new('password_updated_at', type: :datetime).type).to eql(:datetime)
+    end
+  end
+
   describe 'email attributes' do
     it 'recognizes email attributes' do
       expect(described_class.new('email').type).to eql(:email)

data/spec/element_spec.rb

@@ -11,6 +11,11 @@ describe Katapult::Element do
       end.to raise_error(Katapult::Element::UnknownFormattingError,
         'Unknown name formatting: :foobar')
     end
+
+    it 'properly spells human names' do
+      subject = described_class.new('complex_name')
+      expect(subject.name(:human)).to eq 'complex name'
+    end
   end
 
 end

data/spec/model_spec.rb

@@ -7,11 +7,12 @@ describe Katapult::Model do
   subject { described_class.new('model') }
 
   describe '#label_attr' do
-    it 'returns the model’s first attribute' do
-      subject.attr('first_attr')
-      subject.attr('second_attr')
+    it 'returns the model’s first renderable attribute' do
+      subject.attr 'first_attr', type: :json
+      subject.attr 'second_attr'
+      subject.attr 'third_attr'
 
-      expect(subject.label_attr.name).to eql('first_attr')
+      expect(subject.label_attr.name).to eql('second_attr')
     end
   end
 

data/spec/util_spec.rb

@@ -1,22 +1,22 @@
 require 'spec_helper'
-require 'katapult/util'
+require 'katapult/binary_util'
 
-describe Katapult::Util do
+describe Katapult::BinaryUtil do
 
   describe '#git_commit' do
     it 'adds all files before committing' do
-      allow(Katapult::Util).to receive(:system).with(/git add --all; git commit/)
-      Katapult::Util.git_commit 'test'
+      allow(Katapult::BinaryUtil).to receive(:system).with(/git add --all; git commit/)
+      Katapult::BinaryUtil.git_commit 'test'
     end
 
     it 'sets "katapult" as commit author' do
-      allow(Katapult::Util).to receive(:system).with(/git commit.*--author='katapult \<katapult@makandra\.com\>'/)
-      Katapult::Util.git_commit 'test'
+      allow(Katapult::BinaryUtil).to receive(:system).with(/git commit.*--author='katapult \<katapult@makandra\.com\>'/)
+      Katapult::BinaryUtil.git_commit 'test'
     end
 
     it 'sanitizes the commit message' do
-      allow(Katapult::Util).to receive(:system).with(/git commit -m '"hack0r"'/)
-      Katapult::Util.git_commit "\"hack''''0r\""
+      allow(Katapult::BinaryUtil).to receive(:system).with(/git commit -m '"hack0r"'/)
+      Katapult::BinaryUtil.git_commit "\"hack''''0r\""
     end
   end
 

data/spec/wui_spec.rb

@@ -17,6 +17,25 @@ describe Katapult::WUI do
     end
   end
 
+  describe '#crud_only?' do
+    it 'is true for a crud WUI' do
+      subject.crud
+      expect(subject.crud_only?).to be true
+    end
+
+    it 'is false if the WUI has custom actions' do
+      subject.crud
+      subject.action :custom, method: :get, scope: :collection
+      expect(subject.crud_only?).to be false
+    end
+
+    it 'is false if the WUI does not have all CRUD actions' do
+      subject.action :index
+      subject.action :show
+      expect(subject.crud_only?).to be false
+    end
+  end
+
   describe '#model' do
     it 'returns the model object' do
       subject = described_class.new('Customer', model: 'User')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katapult
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dominik Schöler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -139,9 +139,10 @@ files:
 - README.md
 - Rakefile
 - bin/katapult
+- features/authenticate.feature
+- features/basics.feature
 - features/binary.feature
 - features/configuration.feature
-- features/katapult.feature
 - features/model.feature
 - features/navigation.feature
 - features/step_definitions/db_steps.rb
@@ -156,7 +157,9 @@ files:
 - lib/generators/katapult/basics/basics_generator.rb
 - lib/generators/katapult/basics/templates/.gitignore
 - lib/generators/katapult/basics/templates/.ruby-version
+- lib/generators/katapult/basics/templates/Capfile
 - lib/generators/katapult/basics/templates/Gemfile
+- lib/generators/katapult/basics/templates/Guardfile
 - lib/generators/katapult/basics/templates/app/assets/stylesheets/application.sass
 - lib/generators/katapult/basics/templates/app/assets/stylesheets/application/blocks/_all.sass
 - lib/generators/katapult/basics/templates/app/assets/stylesheets/application/blocks/_items.sass
@@ -166,21 +169,52 @@ files:
 - lib/generators/katapult/basics/templates/config/cucumber.yml
 - lib/generators/katapult/basics/templates/config/database.sample.yml
 - lib/generators/katapult/basics/templates/config/database.yml
+- lib/generators/katapult/basics/templates/config/deploy.rb
+- lib/generators/katapult/basics/templates/config/deploy/production.rb
+- lib/generators/katapult/basics/templates/config/deploy/staging.rb
 - lib/generators/katapult/basics/templates/config/initializers/exception_notification.rb.tt
-- lib/generators/katapult/basics/templates/config/initializers/find_by_anything.rb
-- lib/generators/katapult/basics/templates/config/initializers/form_for_with_development_errors.rb
+- lib/generators/katapult/basics/templates/config/initializers/ext.rb
 - lib/generators/katapult/basics/templates/config/spring.rb
 - lib/generators/katapult/basics/templates/features/support/capybara_screenshot.rb
 - lib/generators/katapult/basics/templates/features/support/cucumber_factory.rb
 - lib/generators/katapult/basics/templates/features/support/database_cleaner.rb
 - lib/generators/katapult/basics/templates/features/support/env-custom.rb
+- lib/generators/katapult/basics/templates/features/support/factory_girl.rb
 - lib/generators/katapult/basics/templates/features/support/paths.rb
 - lib/generators/katapult/basics/templates/features/support/selectors.rb
+- lib/generators/katapult/basics/templates/lib/capistrano/tasks/db.rake
+- lib/generators/katapult/basics/templates/lib/capistrano/tasks/deploy.rake
+- lib/generators/katapult/basics/templates/lib/capistrano/tasks/passenger.rake
+- lib/generators/katapult/basics/templates/lib/ext/action_view/form_for_with_development_errors.rb
+- lib/generators/katapult/basics/templates/lib/ext/action_view/spec_label.rb
+- lib/generators/katapult/basics/templates/lib/ext/active_record/find_by_anything.rb
+- lib/generators/katapult/basics/templates/lib/ext/active_record/these.rb
+- lib/generators/katapult/basics/templates/lib/ext/array/xss_aware_join.rb
+- lib/generators/katapult/basics/templates/lib/ext/enumerable/natural_sort.rb
+- lib/generators/katapult/basics/templates/lib/ext/hash/infinite.rb
+- lib/generators/katapult/basics/templates/lib/ext/string/html_entities.rb
+- lib/generators/katapult/basics/templates/lib/ext/string/to_sort_atoms.rb
+- lib/generators/katapult/basics/templates/lib/tasks/pending_migrations.rake
+- lib/generators/katapult/basics/templates/spec/factories/factories.rb
+- lib/generators/katapult/basics/templates/spec/support/factory_girl.rb
 - lib/generators/katapult/basics/templates/spec/support/shoulda_matchers.rb
+- lib/generators/katapult/clearance/clearance_generator.rb
+- lib/generators/katapult/clearance/templates/app/controllers/passwords_controller.rb
+- lib/generators/katapult/clearance/templates/app/views/clearance_mailer/change_password.html.haml
+- lib/generators/katapult/clearance/templates/app/views/clearance_mailer/change_password.text.erb
+- lib/generators/katapult/clearance/templates/app/views/passwords/create.html.haml
+- lib/generators/katapult/clearance/templates/app/views/passwords/edit.html.haml
+- lib/generators/katapult/clearance/templates/app/views/passwords/new.html.haml
+- lib/generators/katapult/clearance/templates/app/views/sessions/new.html.haml
+- lib/generators/katapult/clearance/templates/config/initializers/clearance.rb
+- lib/generators/katapult/clearance/templates/config/locales/clearance.en.yml
+- lib/generators/katapult/clearance/templates/features/authentication.feature
+- lib/generators/katapult/clearance/templates/features/step_definitions/authentication_steps.rb
 - lib/generators/katapult/cucumber_features/cucumber_features_generator.rb
 - lib/generators/katapult/cucumber_features/templates/feature.feature
 - lib/generators/katapult/haml/haml_generator.rb
 - lib/generators/katapult/haml/templates/_form.html.haml
+- lib/generators/katapult/haml/templates/app/views/layouts/_flashes.html.haml
 - lib/generators/katapult/haml/templates/app/views/layouts/application.html.haml
 - lib/generators/katapult/haml/templates/custom_action.html.haml
 - lib/generators/katapult/haml/templates/edit.html.haml
@@ -204,12 +238,13 @@ files:
 - lib/katapult/action.rb
 - lib/katapult/application_model.rb
 - lib/katapult/attribute.rb
+- lib/katapult/authentication.rb
+- lib/katapult/binary_util.rb
 - lib/katapult/element.rb
 - lib/katapult/generator.rb
 - lib/katapult/model.rb
 - lib/katapult/navigation.rb
 - lib/katapult/parser.rb
-- lib/katapult/util.rb
 - lib/katapult/version.rb
 - lib/katapult/wui.rb
 - script/console
@@ -240,14 +275,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Kickstart Rails development
 test_files:
+- features/authenticate.feature
+- features/basics.feature
 - features/binary.feature
 - features/configuration.feature
-- features/katapult.feature
 - features/model.feature
 - features/navigation.feature
 - features/step_definitions/db_steps.rb