decko 0.0.1 → 0.1

data/lib/decko/generators/decko/decko_generator/interactive.rb

@@ -0,0 +1,114 @@
+class DeckoGenerator
+  # 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 options, destination_root
+      @dev = options["core-dev"] || options["mod-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

data/lib/decko/generators/decko/templates/Gemfile

@@ -0,0 +1,124 @@
+source 'http://rubygems.org'
+
+<% if @gem_path.present? %>
+gem 'wagn',        :path=>"<%= @gemfile_gem_path %>/decko"
+gem 'card',        :path=>"<%= @gemfile_gem_path %>/card", :require => false
+<% else %>
+gem 'wagn'
+<% end %>
+
+gem '<%= database_gemfile_entry.name %>'<%= %(, '#{database_gemfile_entry.version}') if database_gemfile_entry.version %>
+
+# Use Unicorn or Thin as server
+# gem 'unicorn'
+# gem 'thin'
+
+# Use Delayed::Job for the Active Job queue to run tasks like
+# sending in notifications in a background process.
+# To activate it you have to set config.active_job.queue_adapter to :delayed_job
+# in your config file and start the background process with
+# RAILS_ENV=production bin/delayed_job start
+# gem 'delayed_job_active_record', '~> 4.1'
+# gem 'daemons'
+
+
+<% if options['mod-dev'] || options['core-dev'] -%>
+group :test do
+  gem 'rspec', '~> 3.4'
+  gem 'rspec-rails'         # behavior-driven-development suite
+  gem 'spork', '>=0.9'
+  gem 'rubocop'
+  gem 'rubocop-decko'
+end
+
+group :test, :development do
+  gem 'rails-dev-tweaks'
+  gem 'jasmine'
+  gem 'jasmine-rails'
+  gem 'jasmine-jquery-rails'
+  gem 'sprockets' # just so above works
+  gem 'phantomjs', '1.9.7.1' #locked because 1.9.8.0 is breaking
+  gem 'test_after_commit'
+  gem 'colorize'
+  gem 'delayed_job_active_record', '~> 4.1'
+
+  <%- if spring_install? %>
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'listen', '3.0.6'
+  gem 'spring'
+  gem 'spring-commands-rspec'
+  gem 'spring-commands-cucumber'
+  <% end -%>
+end
+
+group :debug do
+  gem 'pry-rails'
+  gem 'pry-rescue'
+  gem 'pry-stack_explorer'
+  if RUBY_VERSION =~ /^2/
+    gem 'pry-byebug'
+  else
+    gem 'debugger'
+  end
+end
+<% end -%>
+
+<% if options['core-dev'] -%>
+group :assets do
+  gem 'jquery-rails',  '~> 3.1'                # main js framework, along with rails-specific unobtrusive lib
+  gem 'jquery-ui-rails',  '~> 4.2'             # main js framework, along with rails-specific unobtrusive lib
+  gem "jquery_mobile_rails", "~> 1.4.1"
+
+  gem 'tinymce-rails', '~> 3.4'                # wysiwyg editor
+end
+
+group :test do
+  gem 'fog'
+  gem 'fog-aws'
+  gem 'rspec-html-matchers', '0.8.1' # 0.9 requires ruby >= 2.1
+  gem 'rr' #, '=1.0.0'
+	gem 'simplecov', '~> 0.7.1', :require => false  #test coverage
+  gem 'codeclimate-test-reporter', require: nil
+  # gem 'guard-rspec', '~> 4.2'           # trigger test runs based on file edits,
+                                          # currently not compatible with spring-watcher-listen
+  if RUBY_PLATFORM =~ /darwin/
+    # gem 'terminal-notifier-guard', '~> 1.5'    # use growler notifications on macs
+    # gem 'rspec-legacy_formatters'
+    # gem 'wagn-rspec-formatter', :git=>'https://github.com/xithan/wagn-rspec-formatter.git'
+  end
+
+  # CUKES see features dir
+  gem 'cucumber-rails', '~> 1.4', :require=>false # feature-driven-development suite
+  gem 'capybara', '~> 2.7'
+  gem 'selenium-webdriver', '~> 3.3'
+  gem 'chromedriver-helper', '~> 1.0.0'
+  # gem 'capybara-webkit'
+  gem 'launchy'                                # lets cucumber launch browser windows
+
+  gem 'timecop', '=0.3.5'                      # not clear on use/need.  referred to in shared_data.rb
+  # NOTE: had weird errors with timecop 0.4.4.  would like to update when possible
+
+  gem 'email_spec'                             #
+  gem 'database_cleaner', '~> 1.5 '             # used by cucumber for db transactions
+
+  gem 'turn', :require => false      # Pretty printed test output.  (version constraint is to avoid minitest requirement)
+  gem 'minitest'
+
+  if RUBY_VERSION =~ /^(1|2\.0)/
+    puts "Warning: Can't install i18-tasks without Ruby 2.1+: will not be able to test if I18n keys are missing"
+  else
+    gem 'i18n-tasks', '~> 0.9.5'       # See if I18n keys are missing or unused
+  end
+end
+
+gem 'ruby-prof', :group=>:profile  # profiling
+
+group :debug do
+  gem 'better_errors'
+  gem 'binding_of_caller'
+end
+<% end %>
+
+Dir.glob( 'mod/**{,/*/**}/Gemfile' ).each do |gemfile|
+  instance_eval File.read(gemfile)
+end

data/lib/decko/generators/decko/templates/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# 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__)
+
+<%= app_const %>.load_tasks

data/lib/decko/generators/decko/templates/bin/delayed_job

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "config", "environment"))
+require "delayed/command"
+Delayed::Command.new(ARGV).daemonize

data/lib/decko/generators/decko/templates/bin/spring

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

data/lib/decko/generators/decko/templates/config.ru

@@ -0,0 +1,11 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+<% if options['core-dev'] -%>
+
+if Rails.env.profile?
+  use Rack::RubyProf, :path => 'tmp/profile'
+end
+
+<% end -%>
+run <%= app_const %>

data/lib/decko/generators/decko/templates/config/application.rb

@@ -0,0 +1,91 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'decko/application'
+
+module <%= app_const_base %>
+  class Application < Decko::Application
+    config.performance_logger = nil
+
+    # Decko inherits Rails configuration options.  See http://guides.rubyonrails.org/configuring.html
+
+    # Email configuration
+    config.action_mailer.perform_deliveries = false
+    # config.action_mailer.delivery_method  = ...
+    # config.action_mailer.smtp_settings    = ...
+
+    # Example configuration for mailcatcher, a simple smtp server.
+    # See http://mailcatcher.me for more information
+    # config.action_mailer.delivery_method = :smtp
+    # config.action_mailer.smtp_settings = { address: "localhost", port: 1025 }
+
+
+    # Delayed jobs
+    # Moves time-consuming minor tasks that are part of a card update
+    # (like sending notifications to followers) to a background process.
+    # To activate it add the gems 'delayed_job_active_record' and 'daemons'
+    # to the Gemfile, uncomment the two lines below and run
+    # 'RAILS_ENV=production bin/delayed_job start' to start the background process.
+    # See https://github.com/collectiveidea/delayed_job#running-jobs for more information
+    #
+    # config.active_job.queue_adapter = :delayed_job
+    # Delayed::Worker.delay_jobs = true
+
+    # The below keys are fine for testing but should not be used in production sites.
+
+    # config.read_only = true
+    # defaults to false
+    # disallows creating, updating, and deleting cards.
+
+    # config.cache_store = :file_store, 'tmp/cache'
+    # 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, []
+
+    # config.paths['files'] = 'files'
+    # where uploaded files are actually stored. (eg Image and File cards)
+
+    # config.file_storage = :local
+    # File storage options (see http://decko.org/file_storage_options)
+    # options include: local, cloud, web, coded
+    # defaults to local
+    # For cloud storage use the following config options and add the gems
+    # "fog" and "fog-aws" to your Gemfile.
+    # config.file_default_bucket = :my_bucket
+    # config.file_buckets = {
+    #   my_bucket: {
+    #     provider: "fog/aws",
+    #     directory: "bucket-name",
+    #     subdirectory: "files",
+    #     credentials: {
+    #        provider: 'AWS',                         # required
+    #        aws_access_key_id: 'key',                # required
+    #        aws_secret_access_key: 'secret-key',     # required
+    #        region: 'eu-central-1',                  # optional, defaults to 'us-east-1'
+    #        host: 's3.example.com',                  # optional, defaults to nil
+    #        endpoint: 'https://s3.example.com:8080' # optional, defaults to nil
+    #     },
+    #     attributes: { "Cache-Control" => "max-age=#{365.day.to_i}" },
+    #     public: true,
+    #     read_only: false,                  # if true then updating a file
+    #                                        # in that bucket will move it
+    #                                        # to the default storage location
+    #     authenticated_url_expiration: 180  # if public is set to false this
+    #                                        # option is needed
+    #   }
+    # }
+
+    # 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_protocol = nil
+    # don't autodetect protocol (http/https) from web requests
+  end
+end

data/lib/decko/generators/decko/templates/config/boot.rb

@@ -0,0 +1,15 @@
+# -*- encoding : utf-8 -*-
+
+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 -%>
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("Gemfile")
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

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

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

data/lib/decko/generators/decko/templates/config/databases/frontbase.yml

@@ -0,0 +1,33 @@
+# FrontBase versions 4.x
+#
+# Get the bindings:
+#   gem install ruby-frontbase
+#
+# Configure Using Gemfile
+# gem 'ruby-frontbase'
+#
+development:
+  adapter: frontbase
+  host: localhost
+  database: <%= app_name %>_development
+  username: <%= app_name %>
+  password: ''
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test: &test
+  adapter: frontbase
+  host: localhost
+  database: <%= app_name %>_test
+  username: <%= app_name %>
+  password: ''
+
+cucumber: *test
+
+production: 
+  adapter: frontbase
+  host: localhost
+  database: <%= app_name %>_production
+  username: <%= app_name %>
+  password: ''

data/lib/decko/generators/decko/templates/config/databases/ibm_db.yml

@@ -0,0 +1,88 @@
+# IBM Dataservers
+#
+# Home Page
+#   http://rubyforge.org/projects/rubyibm/
+#
+# To install the ibm_db gem:
+#
+#   On Linux:
+#       . /home/db2inst1/sqllib/db2profile
+#       export IBM_DB_INCLUDE=/opt/ibm/db2/V9.7/include
+#       export IBM_DB_LIB=/opt/ibm/db2/V9.7/lib32
+#       gem install ibm_db
+#
+#   On Mac OS X 10.5:
+#       . /home/db2inst1/sqllib/db2profile
+#       export IBM_DB_INCLUDE=/opt/ibm/db2/V9.7/include
+#       export IBM_DB_LIB=/opt/ibm/db2/V9.7/lib32
+#       export ARCHFLAGS="-arch i386"
+#       gem install ibm_db
+#
+#   On Mac OS X 10.6:
+#       . /home/db2inst1/sqllib/db2profile
+#       export IBM_DB_INCLUDE=/opt/ibm/db2/V9.7/include
+#       export IBM_DB_LIB=/opt/ibm/db2/V9.7/lib64
+#       export ARCHFLAGS="-arch x86_64"
+#       gem install ibm_db
+#
+#   On Windows:
+#       Issue the command: gem install ibm_db
+#
+# Configure Using Gemfile
+# gem 'ibm_db'
+#
+# For more details on the installation and the connection parameters below,
+# please refer to the latest documents at http://rubyforge.org/docman/?group_id=2361
+
+development:
+  adapter: ibm_db
+  username: db2inst1
+  password:
+  database: <%= app_name[0,4] %>_dev
+  #schema: db2inst1
+  #host: localhost
+  #port: 50000
+  #account: my_account
+  #app_user: my_app_user
+  #application: my_application
+  #workstation: my_workstation
+  #security: SSL
+  #timeout: 10
+  #authentication: SERVER
+  #parameterized: false
+
+test: &test
+  adapter: ibm_db
+  username: db2inst1
+  password:
+  database: <%= app_name[0,4] %>_tst
+  #schema: db2inst1
+  #host: localhost
+  #port: 50000
+  #account: my_account
+  #app_user: my_app_user
+  #application: my_application
+  #workstation: my_workstation
+  #security: SSL
+  #timeout: 10
+  #authentication: SERVER
+  #parameterized: false
+
+cucumber: *test
+
+production: 
+  adapter: ibm_db
+  username: db2inst1
+  password:
+  database: <%= app_name[0,8] %>
+  #schema: db2inst1
+  #host: localhost
+  #port: 50000
+  #account: my_account
+  #app_user: my_app_user
+  #application: my_application
+  #workstation: my_workstation
+  #security: SSL
+  #timeout: 10
+  #authentication: SERVER
+  #parameterized: false