runfile-tasks 0.4.8 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8aef7820d14db9860e4c39edebd2d9ec93ce6e499e70715e7b91973278f5eef
-  data.tar.gz: 2d38de90135227ebb7ac28aec14d7fe558c2d4177b19838c7798a310c800a0e8
+  metadata.gz: fcc349ca21afd53c294174a39680782d34ecac53d380e624ccf1da31b836600d
+  data.tar.gz: 2cf17d48577138d6c0e12f898afdc85755220d9d25002c47d638f7e02eaed692
 SHA512:
-  metadata.gz: 45073b116d3ca788b9c34c0410c18e96dd48f448538a8831ba20c9b9bc1607f5e1be039d6de186a3a7fbb3eaac0bc9a5ed03aba9a25d34d9ca5593befa0fa399
-  data.tar.gz: d6e5bf5551d9634d5837b45c0b598b48e65f9a79b0895f11bfebd5b92d75684cb83d771b99d5e89557fb91a150632298f2275532f31571c81ab9d8178f7ed670
+  metadata.gz: 4f9c7ecd0762dff45b63c62f997a495bc8d8b374d7ce0d4ad4fd8a8a161db06812f3cf2a1c58721074e41c3ecb56f969180df1aa3a951fc8a39edd7872a46d9c
+  data.tar.gz: 7f62fc7fb9bbdcd504476a5cbab74d720a933e933f025209d13f2f9a9adfaa1c70970ddf743cae06f315db9c8d61a3c9eecf9c0f8845ac532dc62e565982a151

data/README.md

@@ -180,6 +180,23 @@ RunfileTasks::Docs.rdoc '**/*.{rb,md}', ["--main README.md", "--all",]
 ```
 
 
+### Changelog  Tasks
+
+This command requires that you have [github_changelog_generator] in your Gemfile.
+
+Commands Added:
+
+- `changelog [--commit]` - Generates a changelog and optionally commits it to the git repository.
+
+
+```ruby
+require 'runfile-tasks/changelog'
+
+# Include the task and provide your github user/repo
+RunfileTasks::Changelog.generator "DannyBen/runfile"
+```
+
 ---
 [Runfile]: https://github.com/DannyBen/runfile
 [random cat]: http://thecatapi.com/api/images/get
+[github_changelog_generator]: https://github.com/github-changelog-generator/github-changelog-generator

data/lib/runfile-tasks/all.rb

@@ -3,3 +3,4 @@ require "runfile-tasks/version"
 require "runfile-tasks/rubygems"
 require "runfile-tasks/docs"
 require "runfile-tasks/testing"
+require "runfile-tasks/changelog"

data/lib/runfile-tasks/changelog.rb

@@ -0,0 +1,18 @@
+module RunfileTasks
+  module Changelog
+    extend self
+
+    def generator(repo)
+      usage  "changelog [--commit]"
+      help   "Generate changelog"
+      option "-c, --commit", "Also commit CHANGELOG.md"
+      action :changelog do |args|
+        user, project = repo.split "/"
+        commit = args['--commit'] || args['--push']
+
+        run "github_changelog_generator --project #{project} --user #{user}"
+        run "git add CHANGELOG.md && git commit -m changelog CHANGELOG.md" if commit
+      end
+    end
+  end
+end

data/lib/runfile-tasks/docs/rdoc.rb

@@ -1,25 +1,28 @@
-module RunfileTasks
-  module Docs
-    extend self
-
-    @@default_rdoc_options = [
-      "--main README.md",
-      "--all",
-    ]
-
-    def rdoc(files=nil, options=@@default_rdoc_options)
-      files or files = Dir['**/*.{rb,md}']
-      files = "'" + files.join("' '") + "'"
-      usage  "rdoc [-- OPTIONS...]"
-      help   "Generate documentation using the rdoc command line tool. To pass arguments to rdoc, place them after '--'."
-      action :rdoc do |args|
-        inopts = args['OPTIONS']
-        options = inopts unless inopts.empty?
-        options = options.join(' ')
-        cmd = "rdoc #{options} #{files}"
-        say "!txtgrn!Running: !txtpur!#{cmd}"
-        system cmd
-      end
-    end
-  end
+require 'runfile-tasks/refinements'
+
+module RunfileTasks
+  module Docs
+    extend self
+    using Refinements
+
+    @@default_rdoc_options = [
+      "--main README.md",
+      "--all",
+    ]
+
+    def rdoc(files=nil, options=@@default_rdoc_options)
+      files or files = Dir['**/*.{rb,md}']
+      files = "'" + files.join("' '") + "'"
+      usage  "rdoc [-- OPTIONS...]"
+      help   "Generate documentation using the rdoc command line tool. To pass arguments to rdoc, place them after '--'."
+      action :rdoc do |args|
+        inopts = args['OPTIONS']
+        options = inopts unless inopts.empty?
+        options = options.join(' ')
+        cmd = "rdoc #{options} #{files}"
+        puts "g`Running:` p`#{cmd}`".in_color
+        system cmd
+      end
+    end
+  end
 end

data/lib/runfile-tasks/refinements.rb

@@ -0,0 +1,18 @@
+module RunfileTasks
+  module Refinements
+    refine String do
+      def ansi_colors
+        {
+          r: "\e[31m", g: "\e[32m", y: "\e[33m",
+          b: "\e[34m", p: "\e[35m", c: "\e[36m", n: "\e[0m"
+        }
+      end
+
+      def in_color
+        gsub /(r|g|y|b|p|c|n)\`([^\`]*)\`/ do |code, subtext|
+          "#{ansi_colors[$1.to_sym]}#{$2}#{ansi_colors[:n]}"
+        end
+      end
+    end
+  end
+end

data/lib/runfile-tasks/rubygems/rubygems.rb

@@ -1,8 +1,10 @@
 require 'fileutils'
+require 'runfile-tasks/refinements'
 
 module RunfileTasks
   module RubyGems
     extend self
+    using Refinements
 
     def all(gemname, gemdir="gems")
       build gemname, gemdir
@@ -17,11 +19,11 @@ module RunfileTasks
       usage  "build [--install]"
       help   "Build gem from gemspec and move it to '#{gemdir}' folder.\nUse --install to also install it."
       action :build do |args|
-        say "!txtgrn!Building gem"
+        puts "g`Building gem`".in_color
         cmd = "gem build #{gemname}.gemspec"  
-        say "!txtgrn!Running: !txtpur!#{cmd}"
+        puts "g`Running:` p`#{cmd}`".in_color
         system cmd
-        say "!txtgrn!Moving gem file to #{gemdir}"
+        puts "g`Moving gem file to #{gemdir}`".in_color
         files = Dir["*.gem"]
         Dir.exist? gemdir or FileUtils.mkdir gemdir
         files.each {|f| FileUtils.mv f, gemdir }
@@ -37,7 +39,7 @@ module RunfileTasks
           gemfile = "gems/#{gemname}-#{gemver}.gem"
           cmd = "gem install #{gemfile}"
         end
-        say "!txtgrn!Running: !txtpur!#{cmd}"
+        puts "g`Running:` p`#{cmd}`".in_color
         system cmd
       end
 
@@ -54,7 +56,7 @@ module RunfileTasks
         gemfile = "gems/#{gemname}-#{gemver}.gem"
         File.exist? gemfile or abort "File not found #{gemfile}"
         cmd = "gem push #{gemfile}"
-        say "!txtgrn!Running: !txtpur!#{cmd}"
+        puts "g`Running:` p`#{cmd}`".in_color
         system cmd
       end
 
@@ -63,7 +65,7 @@ module RunfileTasks
       action :yank do |args|
         ver = args['VERSION'] || gemver
         cmd = "gem yank #{gemname} -v #{ver}"
-        say "!txtgrn!Running: !txtpur!#{cmd}"
+        puts "g`Running:` p`#{cmd}`".in_color
         system cmd
       end
       

data/lib/runfile-tasks/testing/cucumber.rb

@@ -1,75 +1,78 @@
-module RunfileTasks
-  module Testing
-    extend self
-
-    def cucumber
-      usage  "(feature|features) [TAG_OR_FILE --list --fast]"
-      help   "Run cucumber feature tests. Optionally, specify a tag or a filename to run. Tags should be prefixed with @."
-      option "--list", "Show list of available features"
-      option "--fast", "Abort on first failure"
-      action :feature, :features do |args|
-        if args['--list']
-          show_cucumber_features
-        else
-          run_cucumber_features args['TAG_OR_FILE'], args['--fast']
-        end
-      end
-    end
-
-    def cucumber_stepdefs(filename='stepdefs.md')
-      usage  "stepdefs"
-      help   "Generate step definitions markdown document.\n" +
-             "Comments in the step definition file that start with two or " +
-             "more # characters, will also be added to the output " +
-             "document, as captions."
-      action :stepdefs do
-        step = /^(Given|When|Then)\((\/.*\/)\) do.*$/
-        caption = /^(\#{2,6} .*)$/
-        files = Dir['features/step_definitions/**/*.rb']
-        doc = []
-        doc << "# Cucumber Step Definitions Summary\n"
-        doc << "Generated by `run stepdefs`."
-        files.each do |file|
-          doc << "\n## #{File.basename(file, '.rb')}\n"
-          File.readlines(file).each do |line|
-            if matches = step.match(line)
-              clause = matches.captures[0]
-              definition = matches.captures[1] # .gsub /(".*?")/, '`__\1__`'
-              doc << "- __`#{clause}`__ `#{definition}`"
-            end
-            if matches = caption.match(line)
-              title = matches.captures[0]
-              doc << "\n#{title}\n"
-            end
-          end
-        end
-        doc = doc.join "\n"
-        File.write filename, doc
-        say "Generated #{filename}"  
-      end
-    end
-
-    def show_cucumber_features
-      say "!txtgrn!Available Features:"
-      Dir['features/**/*.feature'].each do |file|
-        say "- " + File.basename("#{file}", '.feature')
-      end
-    end
-
-    def run_cucumber_features(tag_or_file, fast=false)
-      cmd = "cucumber"
-      if tag_or_file
-        if tag_or_file[0] == '@' 
-          say "!txtgrn!Running features tagged #{tag_or_file}"
-          cmd = "#{cmd} --tags #{tag_or_file}"
-        else
-          say "!txtgrn!Running #{tag_or_file} features"
-          cmd = "#{cmd} 'features/#{tag_or_file}.feature'"
-        end
-      end
-      cmd = "#{cmd} --fail-fast" if fast
-      exec cmd
-    end
-
-  end
-end
+require 'runfile-tasks/refinements'
+
+module RunfileTasks
+  module Testing
+    extend self
+    using Refinements
+
+    def cucumber
+      usage  "(feature|features) [TAG_OR_FILE --list --fast]"
+      help   "Run cucumber feature tests. Optionally, specify a tag or a filename to run. Tags should be prefixed with @."
+      option "--list", "Show list of available features"
+      option "--fast", "Abort on first failure"
+      action :feature, :features do |args|
+        if args['--list']
+          show_cucumber_features
+        else
+          run_cucumber_features args['TAG_OR_FILE'], args['--fast']
+        end
+      end
+    end
+
+    def cucumber_stepdefs(filename='stepdefs.md')
+      usage  "stepdefs"
+      help   "Generate step definitions markdown document.\n" +
+             "Comments in the step definition file that start with two or " +
+             "more # characters, will also be added to the output " +
+             "document, as captions."
+      action :stepdefs do
+        step = /^(Given|When|Then)\((\/.*\/)\) do.*$/
+        caption = /^(\#{2,6} .*)$/
+        files = Dir['features/step_definitions/**/*.rb']
+        doc = []
+        doc << "# Cucumber Step Definitions Summary\n"
+        doc << "Generated by `run stepdefs`."
+        files.each do |file|
+          doc << "\n## #{File.basename(file, '.rb')}\n"
+          File.readlines(file).each do |line|
+            if matches = step.match(line)
+              clause = matches.captures[0]
+              definition = matches.captures[1] # .gsub /(".*?")/, '`__\1__`'
+              doc << "- __`#{clause}`__ `#{definition}`"
+            end
+            if matches = caption.match(line)
+              title = matches.captures[0]
+              doc << "\n#{title}\n"
+            end
+          end
+        end
+        doc = doc.join "\n"
+        File.write filename, doc
+        puts "Generated #{filename}"
+      end
+    end
+
+    def show_cucumber_features
+      puts "g`Available Features:`".in_color
+      Dir['features/**/*.feature'].each do |file|
+        puts "- " + File.basename("#{file}", '.feature')
+      end
+    end
+
+    def run_cucumber_features(tag_or_file, fast=false)
+      cmd = "cucumber"
+      if tag_or_file
+        if tag_or_file[0] == '@' 
+          puts "g`Running features tagged #{tag_or_file}`".in_color
+          cmd = "#{cmd} --tags #{tag_or_file}"
+        else
+          puts "g`Running #{tag_or_file} features`".in_color
+          cmd = "#{cmd} 'features/#{tag_or_file}.feature'"
+        end
+      end
+      cmd = "#{cmd} --fail-fast" if fast
+      exec cmd
+    end
+
+  end
+end

data/lib/runfile-tasks/testing/minitest.rb

@@ -1,23 +1,26 @@
-module RunfileTasks
-  module Testing
-    extend self
-
-    def minitest(pattern="./test/*_test.rb")
-      usage  "test [NAME]"
-      help   "Run all tests or a single test file."
-      action :test do |args|
-        if args['NAME'] 
-          file = pattern.sub "*", args['NAME']
-          say "!txtgrn!Using: !txtpur!#{file}"
-          require file
-        else
-          Dir[pattern].each do |file| 
-            say "!txtgrn!Using: !txtpur!#{file}"
-            require file
-          end
-        end
-      end
-    end
-
-  end
+require 'runfile-tasks/refinements'
+
+module RunfileTasks
+  module Testing
+    extend self
+    using Refinements
+
+    def minitest(pattern="./test/*_test.rb")
+      usage  "test [NAME]"
+      help   "Run all tests or a single test file."
+      action :test do |args|
+        if args['NAME'] 
+          file = pattern.sub "*", args['NAME']
+          puts "g`Using:` p`#{file}`".in_color
+          require file
+        else
+          Dir[pattern].each do |file| 
+            puts "g`Using:` p`#{file}`".in_color
+            require file
+          end
+        end
+      end
+    end
+
+  end
 end

data/lib/runfile-tasks/testing/rspec.rb

@@ -1,45 +1,48 @@
-module RunfileTasks
-  module Testing
-    extend self
-
-    def rspec(opts={})
-      opts = { action: opts } if opts.is_a? String
-      
-      opts = {
-        action:  'spec', 
-        pattern: './spec/**/*_spec.rb',
-        command: 'rspec'
-      }.merge opts
-
-      usage  "#{opts[:action]} [NAME] [TAG]"
-      help   "Run all specs or a single spec file matching a regex. You can provide a tag to run only specific tests. If you wish to provide a tag only, without a file pattern, simply prefix the tag with a colon, like 'run spec :focus'"
-      action opts[:action].to_sym do |args|
-        file = args['NAME'] 
-        tag  = args['TAG'] 
-
-        if file and file[0] == ':'
-          tag = file
-          file = nil
-        end
-
-        if tag and tag[0] == ':'
-          tag = tag[1..-1]
-        end
-
-        if file
-          files = Dir[opts[:pattern]]  
-          files.select! { |f| f =~ /#{file}/i }
-          abort "Cannot find a matching spec file with #{opts[:pattern]}" if files.empty?
-          file = files.first
-          cmd = "#{opts[:command]} \"#{file}\""
-        else
-          cmd = "#{opts[:command]}"
-        end
-        cmd = "#{cmd} --tag #{tag}" if tag
-        say "!txtgrn!Running: !txtpur!#{cmd}"
-        system cmd
-      end
-    end
-  end
-
-end
+require 'runfile-tasks/refinements'
+
+module RunfileTasks
+  module Testing
+    extend self
+    using Refinements
+
+    def rspec(opts={})
+      opts = { action: opts } if opts.is_a? String
+      
+      opts = {
+        action:  'spec', 
+        pattern: './spec/**/*_spec.rb',
+        command: 'rspec'
+      }.merge opts
+
+      usage  opts[:action] == :global ? "[NAME] [TAG]" : "#{opts[:action]} [NAME] [TAG]"
+      help   "Run all specs or a single spec file matching a regex. You can provide a tag to run only specific tests. If you wish to provide a tag only, without a file pattern, simply prefix the tag with a colon, like 'run spec :focus'"
+      action opts[:action].to_sym do |args|
+        file = args['NAME'] 
+        tag  = args['TAG'] 
+
+        if file and file[0] == ':'
+          tag = file
+          file = nil
+        end
+
+        if tag and tag[0] == ':'
+          tag = tag[1..-1]
+        end
+
+        if file
+          files = Dir[opts[:pattern]]  
+          files.select! { |f| f =~ /#{file}/i }
+          abort "Cannot find a matching spec file with #{opts[:pattern]}" if files.empty?
+          file = files.first
+          cmd = "#{opts[:command]} \"#{file}\""
+        else
+          cmd = "#{opts[:command]}"
+        end
+        cmd = "#{cmd} --tag #{tag}" if tag
+        puts "g`Running:` p`#{cmd}`".in_color
+        exec cmd
+      end
+    end
+  end
+
+end

data/lib/runfile-tasks/version.rb

@@ -1,3 +1,3 @@
 module RunfileTasks
-  VERSION = "0.4.8"
+  VERSION = "0.5.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile-tasks
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.5.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-26 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runfile
@@ -33,9 +33,11 @@ files:
 - README.md
 - lib/runfile-tasks.rb
 - lib/runfile-tasks/all.rb
+- lib/runfile-tasks/changelog.rb
 - lib/runfile-tasks/docs.rb
 - lib/runfile-tasks/docs/all.rb
 - lib/runfile-tasks/docs/rdoc.rb
+- lib/runfile-tasks/refinements.rb
 - lib/runfile-tasks/rubygems.rb
 - lib/runfile-tasks/rubygems/all.rb
 - lib/runfile-tasks/rubygems/rubygems.rb
@@ -64,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: Runfile tasks collection