card 1.101.2 → 1.102.0

data/lib/cardio/commands/USAGE

@@ -0,0 +1,28 @@
+  Usage: decko COMMAND [ARGS]
+
+  The most common decko commands are:
+   new         Create a new Decko deck. "decko new my_deck" creates a
+               new deck called MyDeck in "./my_deck"
+   seed        Create and seed the database specified in config/database.yml
+
+   server      Start the Rails server (short-cut alias: "s")
+   console     Start the Rails console (short-cut alias: "c")
+   dbconsole   Start a console for the database specified in config/database.yml
+               (short-cut alias: "db")
+
+  For core developers
+   cucumber     Run cucumber features (short-cut alias: "cc")
+   rspec        Run rspec tests (short-cut alias: "rs")
+   update       Run card migrations
+   load         Load bootstrap data into database
+
+  In addition to those, there are the standard rails commands:
+   generate     Generate new code (short-cut alias: "g")
+   application  Generate the Rails application code
+   destroy      Undo code generated with "generate" (short-cut alias: "d")
+   benchmarker  See how fast a piece of code runs
+   profiler     Get profile information from a piece of code
+   plugin       Install a plugin
+   runner       Run a piece of code in the application environment (short-cut alias: "r")
+
+  All commands can be run with -h (or --help) for more information.

data/lib/cardio/commands/application.rb

@@ -0,0 +1,10 @@
+require "rails/generators"
+require File.expand_path("../../../generators/deck/deck_generator", __FILE__)
+
+if ARGV.first != "new"
+  ARGV[0] = "--help"
+else
+  ARGV.shift
+end
+
+Cardio::Generators::Deck::DeckGenerator.start

data/lib/cardio/commands/command.rb

@@ -0,0 +1,27 @@
+module Cardio
+  class Commands
+    # shared handling of commands splitting cardio and original args with "--"
+    class Command
+      def run
+        puts command
+        exit_with_child_status command
+      end
+
+      def exit_with_child_status command
+        command += " 2>&1"
+        exit $CHILD_STATUS.exitstatus unless system command
+      end
+
+      # split special cardio args and original command args separated by '--'
+      def split_args args
+        before_split = true
+        cardio_args, command_args =
+          args.partition do |a|
+            before_split = (a == "--" ? false : before_split)
+          end
+        command_args.shift
+        [cardio_args, command_args]
+      end
+    end
+  end
+end

data/lib/cardio/commands/rake_command.rb

@@ -0,0 +1,43 @@
+require File.expand_path("command", __dir__)
+# require "pry"
+
+module Cardio
+  class Commands
+    # enhance standard rake command with some decko/card -specific options
+    class RakeCommand < Command
+      def initialize rake_task, args={}
+        @task = rake_task
+        opts = {}
+        if args.is_a? Array
+          Parser.new(rake_task, opts).parse!(args)
+        else
+          opts = args
+        end
+        @envs = Array(opts[:envs])
+      end
+
+      def run
+        commands.each do |cmd|
+          puts cmd
+          # exit_with_child_status cmd
+
+          result = `#{cmd}`
+          process = $CHILD_STATUS
+          puts result
+          exit process.exitstatus unless process.success?
+        end
+      end
+
+      def commands
+        task_cmd = "bundle exec rake #{@task}"
+        return [task_cmd] if !@envs || @envs.empty?
+
+        @envs.map do |env|
+          "env RAILS_ENV=#{env} #{task_cmd}"
+        end
+      end
+    end
+  end
+end
+
+require File.expand_path("rake_command/parser", __dir__)

data/lib/cardio/commands/rake_command/parser.rb

@@ -0,0 +1,50 @@
+# -*- encoding : utf-8 -*-
+
+require "optparse"
+
+module Cardio
+  class Commands
+    class RakeCommand
+      # parse decko/card -specific options for rake
+      class Parser < OptionParser
+        ONS = {
+          production: {
+            desc: "production database (default)"
+          },
+          test: {},
+          development: {},
+          all: {
+            desc: "production, test, and development database",
+            envs: %w[production development test]
+          }
+        }.freeze
+
+        def initialize command, opts
+          super() do |parser|
+            parser.banner = "Usage: decko #{command} [options]\n\n" \
+                            "Run decko:#{command} task on the production "\
+                            " database specified in config/database.yml\n\n"
+            parser_ons parser, command do |env_array|
+              opts[:envs] = env_array
+            end
+          end
+        end
+
+        def parser_ons parser, command
+          ONS.each do |env, vals|
+            parser.on(*parser_on_opts(env, command, vals[:desc])) do
+              yield (vals[:envs] || [env.to_s])
+            end
+          end
+        end
+
+        def parser_on_opts env, command, desc
+          main = "--#{env}"
+          short = "-#{env.to_s[0]}"
+          desc ||= "#{env} database"
+          [main, short, "#{command} #{desc}"]
+        end
+      end
+    end
+  end
+end

data/lib/cardio/commands/rspec_command.rb

@@ -0,0 +1,36 @@
+require File.expand_path("command", __dir__)
+
+module Cardio
+  class Commands
+    # enhance standard RSpec command with some decko/card -specific options
+    class RspecCommand < Command
+      def initialize args
+        require "rspec/core"
+
+        cardio_args, @rspec_args = split_args args
+        @opts = {}
+        Parser.new(@opts).parse!(cardio_args)
+      end
+
+      def command
+        "#{env_args} #{@opts[:executer]} #{@opts[:rescue]}" \
+          "rspec #{@rspec_args.shelljoin} #{@opts[:files]}"
+      end
+
+      private
+
+      def env_args
+        ["RAILS_ROOT=.", coverage].compact.join " "
+      end
+
+      def coverage
+        # no coverage if rspec was started with file argument
+        return unless @opts[:files] || @rspec_args.any?
+
+        "COVERAGE=false"
+      end
+    end
+  end
+end
+
+require File.expand_path("rspec_command/parser", __dir__)

data/lib/cardio/commands/rspec_command/parser.rb

@@ -0,0 +1,120 @@
+# -*- encoding : utf-8 -*-
+
+require "optparse"
+
+module Cardio
+  class Commands
+    class RspecCommand
+      # parse decko/card -specific options for RSpec
+      class Parser < OptionParser
+        RSPEC_PATH_MESSAGE = <<~MESSAGE.freeze
+
+          DECKO ARGS
+
+          You don't have to give a full path for FILENAME; the basename is enough.
+          If FILENAME does not include '_spec', then rspec searches for the
+          corresponding spec file.
+          The line number always refers to the example in the spec file.
+
+        MESSAGE
+
+        RSPEC_BANNER = <<~BANNER.freeze
+
+          Usage: decko rspec [DECKO ARGS] -- [RSPEC ARGS]
+
+          RSPEC ARGS
+
+        BANNER
+
+        DESC = {
+          d: "Run spec for a Decko deck file",
+          c: "Run spec for a Decko core file",
+          m: "Run all specs for a mod or matching a mod"
+        }.freeze
+
+        def initialize opts
+          super() do |parser|
+            parser.banner = RSPEC_BANNER
+            parser.separator RSPEC_PATH_MESSAGE
+
+            file_options parser, opts
+            other_options parser, opts
+            parser.separator "\n"
+          end
+        end
+
+        private
+
+        def file_options parser, opts
+          parser.on("-d", "--spec FILENAME(:LINE)", DESC[:d]) do |file|
+            opts[:files] = find_spec_file(file, "#{Decko.root}/mod")
+          end
+          parser.on("-m", "--mod MODNAME", DESC[:m]) do |file|
+            opts[:files] = find_mod_file(file, Cardio.gem_root)
+          end
+          parser.on("-c", "--core-spec FILENAME(:LINE)", DESC[:c]) do |file|
+            opts[:files] = find_spec_file(file, Cardio.gem_root)
+          end
+        end
+
+        def other_options parser, opts
+          parser.on("-s", "--[no-]simplecov", "Run with simplecov") do |s|
+            opts[:simplecov] = s ? "TMPSETS=true" : ""
+          end
+          parser.on("--rescue", "Run with pry-rescue") do
+            process_rescue_opts opts
+          end
+          parser.on("--[no-]spring", "Run with spring") do |spring|
+            process_spring_opts spring, opts
+          end
+        end
+
+        def process_rescue_opts opts
+          if opts[:executer] == "spring"
+            puts "Disabled pry-rescue. Not compatible with spring."
+          else
+            opts[:rescue] = "rescue "
+          end
+        end
+
+        def process_spring_opts spring, opts
+          if spring
+            opts[:executer] = "spring"
+            if opts[:rescue]
+              opts[:rescue] = ""
+              puts "Disabled pry-rescue. Not compatible with spring."
+            end
+          else
+            opts[:executer] = "bundle exec"
+          end
+        end
+
+        def find_mod_file filename, base_dir
+          if File.exist?("mod/#{filename}") || File.exist?("#{base_dir}/mod/#{filename}")
+            "#{base_dir}/mod/#{filename}"
+          elsif (files = find_spec_file(filename, "mod"))&.present?
+            files
+          else
+            find_spec_file(file, "#{base_dir}/mod")
+          end
+        end
+
+        def find_spec_file filename, base_dir
+          file, line = filename.split(":")
+          if file.include?("_spec.rb") && File.exist?(file)
+            filename
+          else
+            find_matching_spec_files file, line, base_dir
+          end
+        end
+
+        def find_matching_spec_files file, line, base_dir
+          file = File.basename(file, ".rb").sub(/_spec$/, "")
+          Dir.glob("#{base_dir}/**/#{file}_spec.rb").flatten.map do |spec_file|
+            line ? "#{spec_file}:#{line}" : file
+          end.join " "
+        end
+      end
+    end
+  end
+end

data/lib/cardio/defaults.yml

@@ -1,4 +1,5 @@
 ---
+
 # if you disable inline styles tinymce's formatting options stop working
 :allow_inline_styles: true
 :delaying:

data/lib/cardio/generators.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Cardio
+  # for now, this just fulfills zeitwerk expectations. File is here for require calls.
+  module Generators
+    # noop
+  end
+end
+
+module Rails
+  # override to hide all the rails generators that don't apply in a card/decko context
+  module Generators
+    def self.sorted_groups
+      [["card", %w[mod set migration]]]
+    end
+  end
+end

data/lib/cardio/generators/base.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+
+module Cardio
+  module Generators
+    # adds Cardio::Generators::ClassMethods to standard rails generator base class.
+    class Base < ::ActiveRecord::Generators::Base
+      extend ClassMethods
+    end
+  end
+end

data/lib/cardio/generators/class_methods.rb

@@ -0,0 +1,35 @@
+# -*- encoding : utf-8 -*-
+
+module Cardio
+  module Generators
+    # methods shared across Generator bases (which inherit from Rails generator classes)
+    module ClassMethods
+      def source_root path=nil
+        if path
+          @_card_source_root = path
+        else
+          @_card_source_root ||= File.expand_path(
+            "../../../generators/card/#{generator_name}/templates", __FILE__
+          )
+        end
+      end
+
+      # Override Rails default banner (using card/decko for the command name).
+      def banner
+        usage_arguments = arguments.map(&:usage).join " "
+        text = "#{banner_command} generate #{namespace} #{usage_arguments} [options]"
+        text.gsub(/\s+/, " ")
+      end
+
+      def banner_command
+        "card"
+      end
+
+      # Override Rails namespace handling so we can put generators in `module Cardio`
+      def namespace name=nil
+        return super if name
+        @namespace ||= super.sub(/cardio:/, "")
+      end
+    end
+  end
+end

data/lib/cardio/generators/deck_generator_loader.rb

@@ -0,0 +1 @@
+require File.expand_path("../../../generators/deck/deck_generator", __FILE__)

data/lib/cardio/generators/deck_helper.rb

@@ -0,0 +1,97 @@
+module Cardio
+  module Generators
+    # Protected helper methods for DeckGenerator.
+    # Many methods are called from .erb files.
+    module DeckHelper
+      protected
+
+      def shark?
+        !(monkey? || platypus?)
+      end
+
+      def monkey?
+        options[:monkey]
+      end
+
+      def platypus?
+        options[:platypus]
+      end
+
+      def erb_template name
+        template "#{name}.erb", name
+      end
+
+      def repo_path
+        @repo_path ||= determine_repo_path
+      end
+
+      def expanded_repo_path
+        @expanded_repo_path ||= File.expand_path repo_path
+      end
+
+      def determine_repo_path
+        @repo_path_determined ? (return nil) : (@repo_path_determined = true)
+        path = options["repo-path"]
+        path = ENV["DECKO_REPO_PATH"] if path.blank?
+        path = prompt_for_repo_path if path.blank? && platypus?
+        path.to_s
+      end
+
+      def repo_path_constraint subdir=nil
+        repo_path.present? ? %(, path: "#{repo_path}/#{subdir}") : ""
+      end
+
+      def prompt_for_repo_path
+        @repo_path = ask "Enter the path to your local decko repository: "
+      end
+
+      def spec_path
+        @spec_path ||= platypus? ? repo_path : "mod/"
+      end
+
+      def spec_helper_path
+        @spec_helper_path ||=
+          platypus? ? "#{repo_path}/card/spec/spec_helper" : "./spec/spec_helper"
+      end
+
+      def features_path
+        @features_path ||=
+          platypus? ? File.expand_path("#{repo_path}/decko/features/") : "mod/"
+      end
+
+      def database_gem_and_version
+        entry = database_gemfile_entry
+        text = %("#{entry.name}")
+        text << %(, '#{entry.version}') if entry.version
+        # single quotes to prevent, eg: `gem "pg", ">= 0.18', '< 2.0"`
+        text
+      end
+
+      def simplecov_config
+        "" # TODO: add simplecov configs here
+      end
+
+      def jasmine_yml prefix
+        inside("javascripts/support") do
+          template "#{prefix}_jasmine.yml.erb", "jasmine.yml"
+        end
+      end
+
+      def mysql_socket
+        return if RbConfig::CONFIG["host_os"].match?(/mswin|mingw/)
+
+        @mysql_socket ||= [
+          "/tmp/mysql.sock",                        # default
+          "/var/run/mysqld/mysqld.sock",            # debian/gentoo
+          "/var/tmp/mysql.sock",                    # freebsd
+          "/var/lib/mysql/mysql.sock",              # fedora
+          "/opt/local/lib/mysql/mysql.sock",        # fedora
+          "/opt/local/var/run/mysqld/mysqld.sock",  # mac + darwinports + mysql
+          "/opt/local/var/run/mysql4/mysqld.sock",  # mac + darwinports + mysql4
+          "/opt/local/var/run/mysql5/mysqld.sock",  # mac + darwinports + mysql5
+          "/opt/lampp/var/mysql/mysql.sock"         # xampp for linux
+        ].find { |f| File.exist?(f) }
+      end
+    end
+  end
+end