decko 0.10.0 → 0.11.0

data/lib/decko/generators/deck/deck_generator/interactive.rb

@@ -0,0 +1,120 @@
+module Decko
+  module Generators
+    module Deck
+      class DeckGenerator
+        # Guides through the decko deck installation with an interactive menu
+        # Offers the possibilitiy to
+        #  - edit database config
+        #  - edit application.rb
+        #  - seed database
+        #  - run server
+        class Interactive
+          def initialize destination_root, dev=false
+            @dev = dev
+            @destination_root = destination_root
+          end
+
+          def run
+            require config_path("application") # need this for Rails.env
+            @menu = ActiveSupport::OrderedHash.new
+            add_config_options
+            add_seed_options
+            add_exit_option
+            while (answer = ask(build_menu)) != "x"
+              if @menu.key? answer
+                @menu[answer][:code].call
+              else
+                puts "invalid choice"
+              end
+            end
+          end
+
+          private
+
+          def dev_options?
+            @dev
+          end
+
+          def config_path file
+            File.join destination_root, "config", file
+          end
+
+          def bundle_exec command, opts={}
+            rails_env = "RAILS_ENV=#{opts[:rails_env]}" if opts[:rails_env]
+            system "cd #{destination_root} && #{rails_env} bundle exec #{command}"
+          end
+
+          def build_menu
+            lines = ["What would you like to do next?"]
+            lines += @menu.map { |key, v|  build_option key, v[:desc], v[:command] }
+            lines << "[#{@menu.keys.join}]"
+            "\n#{lines.join("\n")}\n"
+          end
+
+          def build_option key, desc, command
+            command &&= " " * (65 - desc.size) + "[" + command + "]"
+            "  #{key} - #{desc}#{command if command}"
+          end
+
+          def add_config_options
+            @menu["d"] = {
+              desc: "edit database configuration file",
+              command: "nano config/database.yml",
+              code: proc { system "nano #{config_path 'database.yml'}" }
+            }
+            @menu["c"] = {
+              desc: "configure Decko (e.g. email settings)",
+              command: "nano config/application.rb",
+              code: proc { system "nano #{config_path 'application.rb'}" }
+            }
+          end
+
+          def add_seed_options
+            add_common_seed_option
+            add_seed_all_option
+          end
+
+          def add_common_seed_option
+            @menu["s"] = {
+              desc: "seed #{Rails.env}#{' and test' if dev_options?} database",
+              command: "decko seed",
+              code: proc do
+                bundle_exec "rake decko:seed"
+                bundle_exec "rake decko:seed", rails_env: "test" if dev_options?
+                add_after_seed_options
+              end
+            }
+          end
+
+          def add_seed_all_option
+            @menu["a"] = {
+              desc: "seed all databases (production, development, and test)",
+              command: "decko seed --all",
+              code: proc do
+                %w[production development test].each do |env|
+                  bundle_exec "rake decko:seed", rails_env: env
+                end
+                add_after_seed_options
+              end
+            }
+          end
+
+          def add_exit_option
+            @menu["x"] = {
+              desc: "exit (run 'decko seed' to complete the installation later)"
+            }
+          end
+
+          def add_after_seed_options
+            @menu["x"][:desc] = "exit"
+            @menu["r"] = {
+              desc:    "run decko server",
+              command: "decko server",
+              code:    proc { bundle_exec "decko server" }
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decko/generators/deck/deck_generator/rails_overrides.rb

@@ -0,0 +1,54 @@
+module Decko
+  module Generators
+    module Deck
+      class DeckGenerator
+        ### the following is straight from rails and is focused on checking
+        # the validity of the app name.needs decko-specific tuning
+        module RailsOverrides
+          protected
+
+          def app_name
+            @app_name ||=
+              defined_app_const_base? ? defined_app_name : File.basename(destination_root)
+          end
+
+          def defined_app_name
+            defined_app_const_base.underscore
+          end
+
+          def defined_app_const_base
+            Rails.respond_to?(:application) && defined?(Rails::Application) &&
+              Decko.application.is_a?(Rails::Application) &&
+              Decko.application.class.name.sub(/::Application$/, "")
+          end
+
+          alias_method :defined_app_const_base?, :defined_app_const_base
+
+          def app_const_base
+            @app_const_base ||= defined_app_const_base ||
+                                app_name.gsub(/\W/, "_").squeeze("_").camelize
+          end
+
+          alias_method :camelized, :app_const_base
+
+          def app_const
+            @app_const ||= "#{app_const_base}::Application"
+          end
+
+          def valid_const?
+            if app_const.match?(/^\d/)
+              invalid_app_name "Please give a name which does not start with numbers."
+            elsif Object.const_defined?(app_const_base)
+              invalid_app_name "constant #{app_const_base} is already in use. " \
+                               "Please choose another application name."
+            end
+          end
+
+          def invalid_app_name message
+            raise Thor::Error, "Invalid application name #{app_name}, #{message}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decko/generators/deck/templates/Gemfile.erb

@@ -0,0 +1,56 @@
+source "http://rubygems.org"
+
+gem "decko"<%= repo_path_constraint %>
+
+
+# DATABASE
+# Decko currently supports MySQL (best tested), PostgreSQL (well tested), and SQLite
+# (not well tested).
+gem <%= database_gem_and_version %>
+
+
+# WEBSERVER
+# To run a simple deck at localhost:3000, you can use thin (recommended), unicorn,
+# or (Rails" default) Webrick
+gem "thin"
+# gem "unicorn"
+
+
+# CARD MODS
+# The easiest way to change card behaviors is with card mods. To install a mod:
+#
+#   1. add `gem "card-mod-MODNAME"` below
+#   2. run `bundle update` to install the code
+#   3. run `decko update` to make any needed changes to your deck
+#
+# The "defaults" includes a lot of functionality that is needed in standard decks.
+gem "card-mod-defaults"
+
+
+# BACKGROUND
+# A background gem is needed to run tasks like sending notifications in a background
+# process.
+# See https://github.com/decko-commons/decko/tree/master/card-mod-delayed_job
+# for additional configuration details.
+<%= "# " if shark? %>gem "card-mod-delayed_job"
+
+
+# MONKEYS
+# You can also create your own mods. Mod developers (or "Monkeys") will want some
+# additional gems to support development and testing.
+<%= "# " if shark? %>gem "card-mod-monkey", group: :development
+<%= "# " if shark? %>gem "decko-rspec", group: :test
+<%= "# " if shark? %>gem "decko-cucumber", group: :cucumber
+<%= "# " if shark? %>gem "decko-cypress", group: %i[test development]
+<%= "# " if shark? %>gem "decko-profile", group: :profile
+<%= "# " if shark? || !spring_install? %>gem "decko-spring"
+
+<% if platypus? %>
+# PLATYPUSES
+# This mod is strongly recommended for platypuses – coders working on the decko core
+gem "card-mod-platypus"
+<% end %>
+
+# The following allows simple (non-gem) mods to specify gems via a Gemfile.
+# You may need to alter this code if you move such mods to an unconventional location.
+Dir.glob("mod/**/Gemfile").each { |gemfile| instance_eval File.read(gemfile) }

data/lib/decko/generators/{decko/templates/bin/spring → deck/templates/bin/spring.erb}

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+GEM_RE = /^GEM$.*?^    (?:  )*spring \((.*?)\)$.*?^$/m
+
 # This file loads spring without using Bundler, in order to be fast
 # It gets overwritten when you run the `spring binstub` command
 
@@ -7,7 +9,7 @@ unless defined?(Spring)
   require "rubygems"
   require "bundler"
 
-  if match = Bundler.default_lockfile.read.match(/^GEM$.*?^    (?:  )*spring \((.*?)\)$.*?^$/m)
+  if (match = Bundler.default_lockfile.read.match GEM_RE)
     ENV["GEM_PATH"] = ([Bundler.bundle_path.to_s] + Gem.path).join(File::PATH_SEPARATOR)
     ENV["GEM_HOME"] = ""
     Gem.paths = ENV

data/lib/decko/generators/{decko/templates/config/application.rb → deck/templates/config/application.rb.erb}

@@ -6,9 +6,15 @@ module <%= app_const_base %>
   class Application < Decko::Application
     config.performance_logger = nil
 
-    # Decko inherits Rails configuration options.  See http://guides.rubyonrails.org/configuring.html
+    # Decko inherits most Ruby-on-Rails configuration options.
+    # See http://guides.rubyonrails.org/configuring.html
+
+    # EMAIL
+    # Email is not turned on by default.  To turn it on, you need to change the
+    # following to `true` and then add configuration specific to your site.
+    # Learn more:
+    #  https://guides.rubyonrails.org/configuring.html#configuring-action-mailer
 
-    # Email configuration
     config.action_mailer.perform_deliveries = false
     # config.action_mailer.delivery_method  = ...
     # config.action_mailer.smtp_settings    = ...
@@ -19,25 +25,25 @@ module <%= app_const_base %>
     # config.action_mailer.smtp_settings = { address: "localhost", port: 1025 }
 
 
-    # Background jobs
-    # Moves time-consuming minor tasks that are part of a card transaction (like sending notifications
-    # to followers) to a background process. To activate it add the 'daemons' gem to the Gemfile, uncomment
-    # the line below and run 'bin/delayed_job start' to start the background process.
-    # See https://github.com/collectiveidea/delayed_job#running-jobs for more information
-    #
-    # Delayed::Worker.delay_jobs = true
+    # BACKGROUND
+    # Decko lets you run some card events (like follower notifications) in the
+    # background. This is off by default but can be turned on by changing the
+    # `delaying` setting to `true`
+    config.active_job.queue_adapter = :delayed_job
+    config.delaying = false
 
-    # config.read_only = true
-    # defaults to false
-    # disallows creating, updating, and deleting cards.
 
+    # CACHING
     # config.cache_store = :file_store, 'tmp/cache'
-    # determines caching mechanism.  options include: file_store, memory_store, mem_cache_store, dalli_store...
+    # determines caching mechanism.  options include: file_store, memory_store,
+    # mem_cache_store, dalli_store...
     #
     # for production, we highly recommend memcache
     # here's a sample configuration for use with the dalli gem
     # config.cache_store = :dalli_store, []
 
+
+    # FILES
     # config.paths['files'] = 'files'
     # directory in which uploaded files are actually stored. (eg Image and File cards)
 
@@ -71,16 +77,31 @@ module <%= app_const_base %>
     #   }
     # }
 
+    # MISCELLANEOUS
+    # config.read_only = true
+    # defaults to false
+    # disallows creating, updating, and deleting cards.
+
     # config.paths['mod'] << 'my-mod-dir'
     # add a new directory for code customizations, or "mods"
 
     # config.allow_inline_styles = false
     # don't strip style attributes (not recommended)
 
-    # config.override_host = nil
-    # don't autodetect host (example.com) from web requests
+    # config.override_host = "example.com"
+    # overrides host auto-detected from web requests
 
-    # config.override_protocol = nil
-    # don't autodetect protocol (http/https) from web requests
+    # config.override_protocol = "https"
+    # overrides protocol auto-detected from web requests
+    <% if platypus? %>
+    config.file_buckets = {
+      test_bucket: {
+        provider: "AWS",
+        aws_access_key_id: ENV["TEST_BUCKET_AWS_ACCESS_KEY_ID"],
+        aws_secret_access_key: ENV["TEST_BUCKET_AWS_SECRET_ACCESS_KEY"],
+        region: "us-east-1"
+      }
+    }
+    <% end %>
   end
 end

data/lib/decko/generators/{decko/templates/config/boot.rb → deck/templates/config/boot.rb.erb}

@@ -3,11 +3,7 @@
 require 'rubygems'
 
 # defaults to development mode without the following
-<% if options['mod-dev'] || options['core-dev'] -%>
-# ENV['RAILS_ENV'] ||= 'production'  
-<% else -%>
-ENV['RAILS_ENV'] ||= 'production'
-<% end -%>
+<%= "# " unless shark? %>ENV['RAILS_ENV'] ||= 'production'
 
 # Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path("Gemfile")

data/lib/decko/generators/deck/templates/config/cucumber.yml

@@ -0,0 +1 @@
+default: '<%= features_path %>'

data/lib/decko/generators/{decko/templates/config/environment.rb → deck/templates/config/environment.rb.erb}

@@ -1,5 +1,5 @@
-# Load the rails application
+# Load the decko application
 require File.expand_path('../application', __FILE__)
 
-# Initialize the rails application
+# Initialize the decko application
 <%= app_const %>.initialize!

data/lib/decko/generators/{decko/templates/config/initializers/cypress_on_rails.rb → deck/templates/config/initializers/cypress.rb}

@@ -1,4 +1,6 @@
 if defined?(CypressOnRails)
+  require "simplecov"
+
   CypressOnRails.configure do |c|
     c.cypress_folder = File.join Decko.gem_root, "spec", "cypress"
     # WARNING!! CypressOnRails can execute arbitrary ruby code

data/lib/decko/generators/{decko → deck}/templates/config/puma.rb

@@ -1,13 +1,13 @@
-workers Integer(ENV['WEB_CONCURRENCY'] || 1)
-min_threads_count = Integer(ENV['RAILS_MIN_THREADS'] || 1)
-max_threads_count = Integer(ENV['RAILS_MAX_THREADS'] || 1)
+workers Integer(ENV["WEB_CONCURRENCY"] || 1)
+min_threads_count = Integer(ENV["RAILS_MIN_THREADS"] || 1)
+max_threads_count = Integer(ENV["RAILS_MAX_THREADS"] || 1)
 threads min_threads_count, max_threads_count
 
 preload_app!
 
 rackup      DefaultRackup
-port        ENV['PORT']     || 3000
-environment ENV['RACK_ENV'] || 'development'
+port        ENV["PORT"]     || 3000
+environment ENV["RACK_ENV"] || "development"
 
 on_worker_boot do
   # Worker specific setup for Rails 4.1+

data/lib/decko/generators/{decko/templates/config/routes.erb → deck/templates/config/routes.rb.erb}

@@ -1,7 +1,7 @@
 # -*- encoding : utf-8 -*-
 
 Decko.application.routes.draw do
-  <% if @include_jasmine_engine %>
+  <% if !shark? %>
     if !Rails.env.production? && Object.const_defined?( :JasmineRails )
       engine = Object.const_get(:JasmineRails).const_get :Engine
       mount engine => "#{rel_root}/specs"

data/lib/decko/generators/deck/templates/pryrc

@@ -0,0 +1,6 @@
+begin
+  puts "Loading pry configuration: (#{File.expand_path __FILE__})"
+  include Cardio::Pry
+rescue NameError
+  puts 'Card config unavailable. Add `gem "card-mod-monkey" to Gemfile to enable.'
+end

data/lib/decko/generators/{decko → deck}/templates/public/robots.txt

@@ -1,4 +1,5 @@
-# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+# See http://www.robotstxt.org/wc/norobots.html
+# for documentation on how to use the robots.txt file
 #
 # To ban all spiders from the entire site uncomment the next two lines:
 # User-Agent: *