jobshop 0.0.0

data/README.md

@@ -0,0 +1,41 @@
+[![Code Climate](https://codeclimate.com/github/frankjmattia/jobshop/badges/gpa.svg)](https://codeclimate.com/github/frankjmattia/jobshop)
+
+# Jobshop
+
+This README is also [available in a friendly, navigable format](http://jobshop.frankjmattia.documentup.com).
+
+## Getting Started
+
+_Jobshop is being actively developed with Rails 5. Patches which add support for Rails 4+ are more than welcome._
+
+Start by adding Jobshop to your Gemfile:
+
+```ruby
+gem "jobshop", "~> 0.0.1"
+```
+
+Run the `bundle` command to install it.
+
+Once Jobshop has been installed you can configure it by running the generator:
+
+```console
+% rails generate jobshop:config
+```
+
+The generator will install an initializer which describes ALL of Jobshop's configuration options.
+
+Add Jobshop to your model using the generator:
+
+```console
+% rails generate jobshop MODEL
+```
+
+Replace MODEL with the class name used for the application’s users (it’s frequently `User` but could also be `Person` or even `Employee`). This will create a model (if one does not exist) and configure it. The generator also configures your `config/routes.rb` file to point to the Jobshop engine.
+
+
+## Bug Reports
+If you discover a problem with Jobshop, we would like to know about it.
+
+https://github.com/frankjmattia/jobshop/issues
+
+If you discover a security related bug, please do NOT use the GitHub issue tracker. Send an email to frankjmattia@jobshop.io

data/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Jobshop"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+Bundler::GemHelper.install_tasks

data/app/assets/config/jobshop_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/jobshop .js
+//= link_directory ../stylesheets/jobshop .css

data/app/assets/javascripts/jobshop/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/jobshop/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/jobshop/application_controller.rb

@@ -0,0 +1,4 @@
+module Jobshop
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/jobshop/application_helper.rb

@@ -0,0 +1,4 @@
+module Jobshop
+  module ApplicationHelper
+  end
+end

data/app/jobs/jobshop/application_job.rb

@@ -0,0 +1,4 @@
+module Jobshop
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/models/application_record.rb

@@ -0,0 +1,5 @@
+module Jobshop
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/jobshop/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Jobshop</title>
+  <%= stylesheet_link_tag    "jobshop/application", media: "all" %>
+  <%= javascript_include_tag "jobshop/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Jobshop::Engine.routes.draw do
+end

data/lib/generators/active_record/jobshop_generator.rb

@@ -0,0 +1,46 @@
+require "rails/generators/active_record"
+require "generators/jobshop/orm_helpers"
+
+module ActiveRecord
+  module Generators
+    class JobshopGenerator < ActiveRecord::Generators::Base
+      include Jobshop::Generators::OrmHelpers
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_jobshop_migration
+        if model_exists_and_invoking? || migration_exists_and_revoking?
+          migration_template "migration_existing.rb", "db/migrate/add_jobshop_to_#{table_name}.rb"
+        else
+          migration_template "migration.rb", "db/migrate/jobshop_create_#{table_name}.rb"
+        end
+      end
+
+      def generate_model
+        invoke "active_record:model", [name], migration: false unless model_exists_and_invoking?
+        invoke "devise:install"
+      end
+
+      def inject_jobshop_content
+        content = <<-CONTENT.strip_heredoc
+          jobshop_user
+        CONTENT
+
+        class_path = namespaced? ? class_name.to_s.split("::") : [ class_name ]
+        indent_depth = class_path.size - 1
+        content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+        inject_into_class(model_path, class_path.last, content) if model_exists?
+      end
+
+      no_tasks do
+        def model_exists_and_invoking?
+          model_exists? && behavior == :invoke
+        end
+
+        def migration_exists_and_revoking?
+          migration_exists?(table_name) && behavior == :revoke
+        end
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb.tt

@@ -0,0 +1,8 @@
+class JobshopCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    enable_extension("pgcrypto")
+    create_table(:<%= table_name %>, id: :uuid, default: gen_random_uuid()) do |t|
+      t.timestamps
+    end
+  end
+end

data/lib/generators/active_record/templates/migration_existing.rb.tt

@@ -0,0 +1,10 @@
+class AddJobshopTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+  end
+
+  def self.down
+    # By default, we don't want to make any assumption about how to roll back a migration when your
+    # model already existed. Please edit below which fields you would like to remove in this migration.
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/generators/jobshop/config/config_generator.rb

@@ -0,0 +1,22 @@
+module Jobshop
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates a Jobshop initializer."
+
+      def load_environment
+        begin
+          require File.expand_path("config/environment.rb")
+        rescue LoadError
+          say "This command must be run from a Rails application's root directory.", :red
+          fail SystemExit
+        end
+      end
+
+      def copy_template
+        template "jobshop.rb.tt", "config/initializers/jobshop.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+Jobshop.configure do |config|
+  # TODO: Add some configure options.
+end

data/lib/generators/jobshop/orm_helpers.rb

@@ -0,0 +1,23 @@
+module Jobshop
+  module Generators
+    module OrmHelpers
+      private
+
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+
+      def migration_exists?(table_name)
+        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_add_jobshop_to_#{table_name}.rb$/).first
+      end
+
+      def migration_path
+        @migration_path ||= File.join("db", "migrate")
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+    end
+  end
+end

data/lib/generators/jobshop_generator.rb

@@ -0,0 +1,20 @@
+module Jobshop
+  module Generators
+    class JobshopGenerator < Rails::Generators::NamedBase
+      namespace "jobshop"
+
+      desc <<-DESC.strip_heredoc
+        Generates a model with the given NAME, a migration (if one does not exist)
+        and adds Jobshop to config/routes.rb
+      DESC
+
+      hook_for :orm
+
+      def add_jobshop_route
+        jobshop_route  = "# jobshop_to :#{plural_name}"
+        jobshop_route << %Q(, class_name: "#{class_name}") if class_name.include?("::")
+        route jobshop_route
+      end
+    end
+  end
+end

data/lib/jobshop/engine.rb

@@ -0,0 +1,12 @@
+require "devise"
+
+module Jobshop
+  class Engine < ::Rails::Engine
+    isolate_namespace Jobshop
+
+    config.generators do |g|
+      g.orm :active_record, primary_key_type: :uuid
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/jobshop/version.rb

@@ -0,0 +1,14 @@
+module Jobshop
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end

data/lib/jobshop.rb

@@ -0,0 +1,35 @@
+require "rails"
+require "rails/all"
+require "jobshop/engine"
+
+module Jobshop
+  class << self
+    attr_writer :configuration
+  end
+
+  # @example
+  #     Jobshop.configuration.user_model = "User"
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+
+  # Yields the global configuration to a block.
+  # @yield [Configuration] global configuration
+  #
+  # @example
+  #     Jobshop.configure do |config|
+  #       config.user_model = "User"
+  #     end
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  class Configuration
+    attr_accessor :user_model
+
+    def initialize
+      @user_model = "User"
+    end
+  end
+end

data/lib/tasks/jobshop_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :jobshop do
+#   # Task goes here
+# end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link jobshop_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.coffee

@@ -0,0 +1,11 @@
+# Action Cable provides the framework to deal with WebSockets in Rails. 
+# You can generate new channels where WebSocket features live using the rails generate channel command.
+#
+# Turn on the cable connection by removing the comments after the require statements (and ensure it's also on in config/routes.rb).
+#
+#= require action_cable
+#= require_self
+#= require_tree ./channels
+#
+# @App ||= {}
+# App.cable = ActionCable.createConsumer()

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file. Action Cable runs in an EventMachine loop that does not support auto reloading.
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file. Action Cable runs in an EventMachine loop that does not support auto reloading.
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= action_cable_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') or system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system 'bundle check' or system! 'bundle install'
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "jobshop"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# 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__)