jobshop 0.0.67 → 0.0.101

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 269cd370a578899a10889f466384114b6672b2d5
-  data.tar.gz: bdff6efb80939367914d280e5bf84663c92fc24b
+  metadata.gz: 2dd90b50e7feb98aff7c02039f85914a92b21789
+  data.tar.gz: b08d3ec5ff1e5160bee39de1077be79cf870209e
 SHA512:
-  metadata.gz: ec3a60f34dbe0139371b259a8651be8465b28199e0521a1377246ed0fb52b30899378b3bea6d76d6d4fa10803372ab4c602221198b7f05369ca8390b2186bd62
-  data.tar.gz: 213a5e8e78e79a422e854e2000873b90636129aba8a4811d9e58b34d5e5548773f6e9ce7752fc236e4d3c0017dc5ef62d1d84417d46c44cee8a35e516b5aa604
+  metadata.gz: 715aaa6e6ea388e208074804f4141c36bca7a303579379d727afa67d118449128eba94e2ebe99a87a2784476031ae18c894df5db1ba39baaded235c55fa2efe9
+  data.tar.gz: ada7575067365e3785eb7eecb2f32bd040ba06ec1c2ba613962348e60418c84462acd570e7ca11ce55fb7a7bae8a861755a0211f6cef9aff8b0f30079ed31e38

data/README.md

@@ -7,32 +7,33 @@
 
 Real-time production tracking and process evaluation in the cloud - or under your own roof.
 
-To see a live demo, check out [jobshop.io](https://jobshop.io).
-
 ## Requirements
 
 Jobshop only requires a few things:
 
-  - Ruby >= 2.3
+  - Ruby >= 2.4
   - Rails >= 5.0
-  - PostgreSQL
+  - PostgreSQL >= 9.5
 
 ## Quick Installation
 
 The Quick Installation is designed to get you up and running a local Jobshop
 server with minimum effort. This instance will be ideal for evaluating Jobshop
-on a small number of stations within your organization. If you would like to
+at any number of stations within your organization. If you would like to
 deploy to a production server or create a local development instance, a few
 extra considerations will need to be made. There are no guides yet but pull
 requests are always welcome.
 
-First, generate a new rails app and target the PostgreSQL adapter. The provided
-application template does all the heavy lifting. It adds Jobshop to your
-`Gemfile`, defines reasonable defaults in `config/secrets.yml` and adds a route
-for the `Jobshop::Engine` to `config/routes.rb`.
+First, install the Jobshop gem.
+
+```console
+$ gem install jobshop
+```
+
+Then create your app:
 
 ```console
-$ rails new my_jobshop --database=postgresql -m https://templates.jobshop.io/quick_install.rb
+$ jobshop new my_jobshop
 ```
 
 Change into the app directory.
@@ -47,13 +48,14 @@ and edit as necessary. Create the database.
 ```console
 $ rails db:create
 ```
+
 Run the newly pending migrations.
 
 ```console
 $ rails db:migrate
 ```
 
-Fire up your server with `$ rails s` and point your web browser to
+Fire up your server with `rails s` and point your web browser to
 [http://localhost:3000](http://localhost:3000)
 
 ## Bug Reports

data/lib/generators/jobshop/app/USAGE

@@ -0,0 +1,8 @@
+Description:
+  The `jobshop new` command creates a new Jobshop application with a default
+  directory structure and configuration at the path you specify.
+
+Example:
+  jobshop new ~/src/my_jobshop
+
+  This generates a skeletal Jobshop installation in ~/src/my_jobshop.

data/lib/generators/jobshop/app/app_generator.rb

@@ -0,0 +1,70 @@
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
+
+require "jobshop/version"
+
+module Jobshop
+  class AppBuilder < Rails::AppBuilder
+    def readme
+      template "README.md.tt"
+    end
+
+    def gemfile
+      super
+      append_to_file "Gemfile", <<~GEMFILE
+        \ngem "jobshop", "~> #{Jobshop.gem_version}"
+      GEMFILE
+    end
+
+    def config
+      super
+      template "config/secrets.yml.tt", force: true
+    end
+
+    def mount_engine
+      route %Q(mount Jobshop::Engine => "/")
+    end
+  end
+
+  module Generators
+    class AppGenerator < Rails::Generators::AppGenerator
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+
+      def self.source_paths
+        [ Rails::Generators::AppGenerator.source_root,
+          Jobshop::Generators::AppGenerator.source_root ]
+      end
+
+      hide!
+
+      class_option :help, type: :boolean, aliases: "-h", group: :other,
+        desc: "Show this help message and quit"
+
+      class_options[:database].instance_variable_set(:@default, "postgresql")
+
+      class_option :version, type: :boolean, aliases: "-v", group: :other,
+              desc: "Show Jobshop version number and quit"
+
+      def self.banner
+        "jobshop new #{arguments.map(&:usage).join(' ')} [options]"
+      end
+
+      def finish_template
+        build :mount_engine
+        super
+      end
+
+      def run_bundle
+        super
+        bundle_command("binstub jobshop") if bundle_install?
+      end
+
+    protected
+      def get_builder_class
+        Jobshop::AppBuilder
+      end
+    end
+  end
+end

data/lib/generators/jobshop/app/templates/README.md.tt

@@ -0,0 +1,3 @@
+# README
+
+You're running Jobshop!

data/lib/generators/jobshop/dummy/dummy_generator.rb

@@ -0,0 +1,101 @@
+require "jobshop/dummy_app"
+require "generators/jobshop/app/app_generator"
+
+module Jobshop
+  class DummyBuilder < Jobshop::AppBuilder
+    def readme
+      # Do not generate README.md
+    end
+
+    # Comment out username, password from production group.
+    def config_database_yml
+      gsub_file "config/database.yml",
+        /^([ ]*[^#])(username: .*|password: .*)$/, '\1# \2'
+    end
+
+    # The db/migrate folder isn't created automatically.
+    def db_migrate
+      unless Dir.exist?("db/migrate")
+        say_status :create, "db/migrate"
+        Dir.mkdir("db/migrate")
+      end
+    end
+
+    def expose_mailer_previews
+      # Mailer previews don't really play nice with Engines so in the dummy app we
+      # create an initializer to expose them properly.
+      initializer "jobshop_expose_mailer_previews.rb", <<~INITIALIZER
+        if Rails.env.development? || Rails.env.test?
+          Rails.application.configure do
+            config.action_mailer.preview_path = "\#{Jobshop::Engine.root}/spec/mailers"
+          end
+        end
+      INITIALIZER
+    end
+
+    def localhost_tld_length
+      # This allows us to easily use the localhost hostname in development.
+      initializer "jobshop_tld_length.rb", <<~INITIALIZER
+        if Rails.env.development? || Rails.env.test?
+          Rails.application.configure do
+            config.action_dispatch.tld_length = 0
+          end
+        end
+      INITIALIZER
+    end
+  end
+
+  module Generators
+    class DummyGenerator < Jobshop::Generators::AppGenerator
+      def self.source_root
+        File.expand_path("templates", __dir__)
+      end
+
+      def self.source_paths
+        Array(super) | [ Jobshop::Generators::DummyGenerator.source_root ]
+      end
+
+      hide!
+
+      class_options[:skip_bundle].instance_variable_set(:@default, "true")
+      class_options[:skip_gemfile].instance_variable_set(:@default, "true")
+      class_options[:skip_git].instance_variable_set(:@default, "true")
+      class_options[:skip_listen].instance_variable_set(:@default, "true")
+      class_options[:skip_test].instance_variable_set(:@default, "true")
+
+      def initialize(*)
+        DummyApp.destroy! if Jobshop::DummyApp.exist?
+        super
+      end
+
+      def self.banner
+        "jobshop dummy [options]"
+      end
+
+      def create_boot_file
+        template "config/boot.rb.tt"
+      end
+
+      def finish_template
+        build :config_database_yml
+        build :db_migrate
+        build :expose_mailer_previews
+        build :localhost_tld_length
+        super
+      end
+
+      def run_bundle
+        super
+        bundle_command("binstub jobshop --path=\"#{Jobshop::DummyApp.path}/bin\" --force")
+        bundle_command("exec rails db:drop RAILS_ENV=test")
+        bundle_command("exec rails db:create RAILS_ENV=test")
+        bundle_command("exec rails db:migrate RAILS_ENV=test")
+      end
+
+    protected
+      def get_builder_class
+        Jobshop::DummyBuilder
+      end
+    end
+  end
+end

data/lib/generators/jobshop/dummy/templates/config/boot.rb.tt

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/lib/jobshop/cli.rb

@@ -1,17 +1,66 @@
 require "thor"
 
-require "jobshop"
-require "jobshop/version"
+require "jobshop/dummy_app"
+require "generators/jobshop/app/app_generator"
+require "generators/jobshop/dummy/dummy_generator"
 
 module Jobshop
-  class CLI < Thor
-    package_name "Jobshop"
+  class CLI
+    class Unbound < Thor
+      desc "new", "Create a new Jobshop application"
+      default_command def new(*)
+        Jobshop::Generators::AppGenerator.start \
+          Rails::Generators::ARGVScrubber.new(ARGV).prepare!
+      end
 
-    map "-v" => :version
+      def help
+        Jobshop::Generators::AppGenerator.help(shell)
+      end
+    end
+
+    class Dummy < Thor
+      desc "create", "Create the dummy app"
+      default_command def create
+        ARGV.shift; ARGV.unshift("new", Jobshop::DummyApp.path)
+        Jobshop::Generators::DummyGenerator.start \
+          Rails::Generators::ARGVScrubber.new(ARGV).prepare!
+      end
+    end
+
+    class Development < Thor
+      register Jobshop::CLI::Dummy, "dummy", "dummy [options]", "Manage dummy app used for tests"
+    end
+
+    class << self
+      def start
+        if [ "-v", "--version" ].include?(ARGV[0])
+          require "jobshop/version"
+          puts "Jobshop #{Jobshop.gem_version}"
+          exit 0
+        elsif jobshop_application?
+          puts "No tasks available for the application environment yet"
+        elsif jobshop_development?
+          Jobshop::CLI::Development.start
+        else
+          Jobshop::CLI::Unbound.start
+        end
+      end
+
+      private def jobshop_application?
+        has_executable? && !has_gemspec?
+      end
+
+      private def jobshop_development?
+        has_executable? && has_gemspec?
+      end
+
+      private def has_executable?
+        @has_executable ||= File.file?("bin/jobshop")
+      end
 
-    desc "version", "Print Jobshop version and exit."
-    def version
-      puts "Jobshop v#{Jobshop.gem_version}"
+      private def has_gemspec?
+        @jobshop_development ||= File.file?("jobshop.gemspec")
+      end
     end
   end
 end

data/lib/jobshop/dummy_app.rb

@@ -1,58 +1,23 @@
-require "rails/generators/rails/app/app_generator"
+require "rails/version"
 
 module Jobshop
   class DummyApp
     class << self
-      def require_environment!
-        if exist?
-          require File.join(path, "config/environment")
-        else
-          abort("Dummy app does not exist. Please run `rake jobshop:dummy` to create it.")
-        end
-      end
-
-      def exist?
-        Dir.exist?(path)
-      end
-
       def destroy!
         FileUtils.rmtree(path)
-        Object.send(:remove_const, constant_name)
       end
 
-      def path
-        @path ||= File.expand_path("spec/dummy-#{Rails::VERSION::STRING}")
-      end
-
-      def constant_name
-        @constant_name = File.basename(path)
-          .gsub(/\W/, '_').squeeze('_').camelize
+      def exist?
+        Dir.exist?(path)
       end
 
       def rakefile
         File.join(path, "Rakefile")
       end
 
-      def template
-        @template ||=
-          File.expand_path("templates/dummy_template.rb", __dir__)
+      def path
+        @path ||= File.expand_path("spec/dummy-#{Rails::VERSION::STRING}")
       end
     end
-
-    def initialize
-      options = {
-        api: false,
-        database: "postgresql",
-        skip_gemfile: true,
-        skip_git: true,
-        skip_bundle: true,
-        skip_listen: true,
-        skip_test: true,
-        template: DummyApp.template
-      }
-
-      DummyApp.destroy! if DummyApp.exist?
-      Rails::Generators::AppGenerator.new([ DummyApp.path ], options).invoke_all
-    end
   end
 end

data/lib/jobshop/version.rb

@@ -6,7 +6,7 @@ module Jobshop
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 67
+    TINY  = 101
     PRE   = nil
 
     CODE_NAME = "bump it up prime".freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jobshop
 version: !ruby/object:Gem::Version
-  version: 0.0.67
+  version: 0.0.101
 platform: ruby
 authors:
 - Frank J. Mattia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-04 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -382,8 +382,14 @@ files:
 - db/migrate/20160720201947_add_authentication_token_to_jobshop_users.rb
 - db/migrate/keep
 - exe/jobshop
+- lib/generators/jobshop/app/USAGE
+- lib/generators/jobshop/app/app_generator.rb
+- lib/generators/jobshop/app/templates/README.md.tt
+- lib/generators/jobshop/app/templates/config/secrets.yml.tt
 - lib/generators/jobshop/config/config_generator.rb
 - lib/generators/jobshop/config/templates/jobshop.rb.tt
+- lib/generators/jobshop/dummy/dummy_generator.rb
+- lib/generators/jobshop/dummy/templates/config/boot.rb.tt
 - lib/generators/jobshop/orm_helpers.rb
 - lib/generators/jobshop/team/USAGE
 - lib/generators/jobshop/team/team_generator.rb
@@ -393,13 +399,8 @@ files:
 - lib/jobshop/engine.rb
 - lib/jobshop/failure_app.rb
 - lib/jobshop/support/memo_attr.rb
-- lib/jobshop/templates/boot.rb.tt
-- lib/jobshop/templates/dummy_template.rb
-- lib/jobshop/templates/quick_install.rb
-- lib/jobshop/templates/secrets.yml.erb
 - lib/jobshop/version.rb
 - lib/tasks/jobshop_tasks.rake
-- lib/templates/haml/scaffold/_form.html.haml
 homepage: https://jobshop.io
 licenses:
 - AGPL-3.0

data/lib/jobshop/templates/boot.rb.tt

@@ -1,5 +0,0 @@
-# Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
-
-require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
-$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/lib/jobshop/templates/dummy_template.rb

@@ -1,48 +0,0 @@
-def source_paths
-  [ File.expand_path(File.dirname(__FILE__)) ]
-end
-
-# The generated config/boot.rb file references a Gemfile in the dummy app
-# directory so use one that references the parent app.
-remove_file "config/boot.rb"
-copy_file "boot.rb.tt", "config/boot.rb"
-
-# The generated config/secrets.yml file uses hardcoded values for
-# test/development environments. Generate secrets pragmatically.
-remove_file "config/secrets.yml"
-template "secrets.yml.erb", "config/secrets.yml"
-
-# Comment out username, password from production group.
-gsub_file "config/database.yml",
-  /^([ ]*[^#])(username: .*|password: .*)$/, '\1# \2'
-
-# The db/migrate folder never gets created for the dummy_app so do it manually.
-unless Dir.exist?("db/migrate")
-  say_status :create, "db/migrate"
-  Dir.mkdir("db/migrate")
-end
-
-# Mailer previews don't really play nice with Engines so in the dummy app we
-# create an initializer to expose them properly.
-initializer "jobshop_expose_mailer_previews.rb", <<-INITIALIZER.strip_heredoc
-  if Rails.env.development? || Rails.env.test?
-    Rails.application.configure do
-      config.action_mailer.preview_path = "\#{Jobshop::Engine.root}/spec/mailers"
-    end
-  end
-INITIALIZER
-
-# This allows us to easily use the localhost hostname in development.
-initializer "jobshop_tld_length.rb", <<-INITIALIZER.strip_heredoc
-  if Rails.env.development? || Rails.env.test?
-    Rails.application.configure do
-      config.action_dispatch.tld_length = 0
-    end
-  end
-INITIALIZER
-
-route "mount Jobshop::Engine => \"/\""
-
-rake "db:drop:all"
-rake "db:create"
-rake "db:migrate"

data/lib/jobshop/templates/quick_install.rb

@@ -1,30 +0,0 @@
-require "tempfile"
-require "net/http"
-
-# Add jobshop to the application `Gemfile`.
-gem "jobshop", "~> 0.0.11"
-
-def template_body(uri)
-  uri = URI.parse(uri)
-  Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-    http.request(Net::HTTP::Get.new(uri))
-  end.body
-end
-
-# The generated config/secrets.yml file uses hardcoded values for
-# test/development environments. Generate secrets pragmatically.
-SECRETS_YML_URI = "https://raw.githubusercontent.com/" +
-                  "jobshop/jobshop/" +
-                  "master/lib/jobshop/templates/secrets.yml.erb"
-
-secrets_tempfile = Tempfile.new(["secrets", ".yml.erb"])
-secrets_tempfile.write(template_body(SECRETS_YML_URI))
-secrets_tempfile.close
-
-remove_file "config/secrets.yml"
-template secrets_tempfile.path, "config/secrets.yml"
-secrets_tempfile.unlink
-
-after_bundle do
-  route %Q(mount Jobshop::Engine => "/")
-end

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

@@ -1,10 +0,0 @@
-= simple_form_for(@<%= singular_table_name %>) do |f|
-  = f.error_notification
-
-  .form-inputs
-  <%- attributes.each do |attribute| -%>
-    = f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %>
-  <%- end -%>
-
-  .form-actions
-    = f.button :submit