Merge pull request #79 from opal/elia/project-initializer

Add a project initializer (+ fixes)

Author: elia

CHANGELOG.md

@@ -1,3 +1,10 @@
+# Opal-RSpec Changelog
+
+## 0.7.1 - unreleased
+
+- add a project initializer: `opal-rspec --init`
+
+
 ## 0.7.0 - 2019-02-03
 
 - Drop support for the legacy async syntax

exe/opal-rspec

@@ -10,6 +10,11 @@ require 'optparse'
 
 options = {}
 OptionParser.new do |parser|
+  parser.on('--init', 'Initialize your project with Opal-RSpec.') do |_cmd|
+    Opal::RSpec::ProjectInitializer.new.run
+    exit
+  end
+
   parser.on('-c', '--[no-]color', '--[no-]colour', 'Enable color in the output.') do |o|
     options[:color] = o
   end
@@ -23,17 +28,21 @@ OptionParser.new do |parser|
     options[:formatters] ||= []
     options[:formatters] << [o]
   end
+
   parser.on('-r', '--require PATH', 'Require a file.') do |path|
     options[:requires] ||= []
     options[:requires] << path
   end
+
   parser.on('-I PATH', 'Specify PATH to add to $LOAD_PATH (may be used more than once).') do |dir|
     options[:includes] ||= []
     options[:includes] << dir
   end
+
   parser.on('-P', '--pattern PATTERN', 'Load files matching pattern (default: "spec-opal/**/*_spec.rb").') do |o|
     options[:pattern] = o
   end
+
   parser.on('--default-path PATH', 'Set the default path where RSpec looks for examples (can',
             '  be a path to a file or a directory).') do |path|
     options[:default_path] = path
@@ -44,9 +53,7 @@ OptionParser.new do |parser|
   parser.on('-R', '--runner NAME', 'Use a different JS runner (default is nodejs)') do |name|
     options[:runner] = name
   end
-
 end.parse!
-# p options: options
 
 runner = Opal::RSpec::Runner.new do |server, config|
   spec_opts = []
@@ -55,7 +62,8 @@ runner = Opal::RSpec::Runner.new do |server, config|
   raise "can accept only one formatter at this time" if options[:formatters] && options[:formatters].size != 1
   spec_opts += ['--format', options[:formatters].flatten.first] if options[:formatters]
   raw_files = ARGV
-  # p raw_files: ARGV
+  raw_files = ['spec-opal'] if raw_files.empty?
+
   files = raw_files.flat_map do |file|
     if File.directory? file
       Dir[File.join(file, '**{,/*/**}/*_spec{.js,}.rb')]
@@ -65,14 +73,12 @@ runner = Opal::RSpec::Runner.new do |server, config|
       raise "Can't stat path: #{file}"
     end
   end
-  # p files: files
 
   options[:includes].each {|dir| server.append_path dir} if options[:includes]
   config.default_path = options[:default_path]           if options[:default_path]
   config.spec_opts    = spec_opts.shelljoin
   config.files        = files
 end
 
-# puts runner.command
 runner.run
 

lib/opal/rspec.rb

@@ -18,6 +18,8 @@
 
 module Opal
   module RSpec
+    autoload :ProjectInitializer, 'opal/rspec/project_initializer'
+
     def self.spec_opts_code(spec_opts)
       code = []
       if spec_opts && !spec_opts.empty?

lib/opal/rspec/locator.rb

@@ -9,7 +9,8 @@ module RSpec
     class Locator
       include ::RSpec::Core::RubyProject
 
-      DEFAULT_PATTERN = 'spec-opal/**/*_spec{.js,}.{rb,opal}'
+      DEFAULT_GLOB = '**{,/*/**}/*_spec{.js,}.{rb,opal}'
+      DEFAULT_PATTERN = "spec-opal/#{DEFAULT_GLOB}"
       DEFAULT_DEFAULT_PATH = 'spec-opal'
 
       attr_accessor :spec_pattern, :spec_exclude_pattern, :spec_files, :default_path

lib/opal/rspec/project_initializer.rb

@@ -0,0 +1,48 @@
+require 'fileutils'
+
+module Opal
+  module RSpec
+    # @private
+    # Generates conventional files for an rspec project
+    class ProjectInitializer
+      attr_reader :destination, :stream, :template_path
+
+      DOT_RSPEC_FILE = '.rspec-opal'
+      SPEC_HELPER_FILE =  'spec-opal/spec_helper.rb'
+
+      def initialize(opts={})
+        @destination = opts.fetch(:destination, Dir.getwd)
+        @stream = opts.fetch(:report_stream, $stdout)
+        @template_path = opts.fetch(:template_path) do
+          File.expand_path("../project_initializer", __FILE__)
+        end
+      end
+
+      def run
+        copy_template DOT_RSPEC_FILE
+        copy_template SPEC_HELPER_FILE
+      end
+
+    private
+
+      def copy_template(file)
+        destination_file = File.join(destination, file)
+        return report_exists(file) if File.exist?(destination_file)
+
+        report_creating(file)
+        FileUtils.mkdir_p(File.dirname(destination_file))
+        File.open(destination_file, 'w') do |f|
+          f.write File.read(File.join(template_path, file))
+        end
+      end
+
+      def report_exists(file)
+        stream.puts "   exist   #{file}"
+      end
+
+      def report_creating(file)
+        stream.puts "  create   #{file}"
+      end
+    end
+  end
+end

lib/opal/rspec/project_initializer/.rspec-opal

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

lib/opal/rspec/project_initializer/spec-opal/spec_helper.rb

@@ -0,0 +1,13 @@
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end