gemmyrb 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18532f58f02f659faa596f0ed22dd3f85acfa1a4
-  data.tar.gz: 17ee68de85cf655f22bb5190e33a27378ecee904
+  metadata.gz: ee07c91962027fdbdf91efbc60abb03d4ffd502b
+  data.tar.gz: 7240a639bd4a4ee45d14e7bc43ed65974f54a192
 SHA512:
-  metadata.gz: 32ef4734ff5168c54883208469f150927eb09053786e8dc6f5721f6d449061f509a60b0a1028eca628d973ef042339d4e55ee9be8d9c3edba1aea3ecf2e60d7c
-  data.tar.gz: cee902db7fa77e8e555f6473bf4bd1191353206df35697d0ade31a5bcb0a13322db9335ebbb59a330810cb4aacc3c1ad3e04c0f035b5dabf99d06b0799360c85
+  metadata.gz: b8f6440c315b9c538ad06b178570d298f8f14e89b951221989cb122bcee97887f58a3ed05a80a2f76dcdd0af9f90492c3b7b13d6a94211c45f281d231e1ce030
+  data.tar.gz: 1356ede85fc8a5bd3fd6aeeedefb583d2c69be86511860997b5c16e7e663f1ecad0882af187b6904e93d9f3ad9a7cd986c31acc253c48ea5f0bfcc2154f1bd65

data/README.md

@@ -1,18 +1,21 @@
 ### Gemmy gem
 
-This is a general purpose gem.
+This is a general purpose gem which adds functionality to the ruby language
+and defines some system tasks, such as generating a gem.
 
-I'm continually adding small core patches and utility classes.
+It is on RubyGems. Because there is an existing gem named `gemmy`, the name passed to `gem install` is `gemmyrb`. But `require 'gemmy'` is still used.
 
-It is on RubyGems and can be installed with `gem install gemmyrb`
+RubyGems hosts the YARD documentation at [http://www.rubydoc.info/gems/gemmyrb](http://www.rubydoc.info/gems/gemmyrb), but it's only updated when I push
+a new gem version. So the version here on Github's master branch might contain
+undocumented functionality. I'll try to keep the RubyGems version up-to-date though.
 
-**note**
+YARD is not the best for a birds-eye overview. For that, see the following
+documents:
 
-because there is an existing gem named `gemmy`, the name passed
-to `gem install` is `gemmyrb`. But `require 'gemmy'` is still used. 
-
-For more information, see the following documents:
-
-- [examples/01_using_as_refinement.rb](.examples/01_using_as_refinement.rb)
-- [examples/02_using_globally.rb](.examples/02_using_globally.rb)
-- [examples/03_full_api.rb](.examples/03_full_api.rb)
+- _Loading the gem's code in different scopes_
+  - [examples/01_using_as_refinement.rb](./examples/01_using_as_refinement.rb)
+  - [examples/02_using_globally.rb](./examples/02_using_globally.rb)
+- _List of methods intended for general Ruby use_
+  - [examples/03_ruby_extensions_list.rb](./examples/03_ruby_extensions_list.rb)
+- _Shell commands and other one-off processes_
+  - [examples/04_shell_commands.rb](./04_shell_commands.rb)

data/lib/gemmy/components/dynamic_steps.rb

@@ -1,6 +1,7 @@
 # Mimics the Cucumber API:
-#   {DynamicSteps#step} runs a step
-#   {DynamicSteps#define_step} defines a step
+#
+#   {#step} runs a step
+#   {#define_step} defines a step
 #
 # The usage is the same as Cucumber:
 #
@@ -12,7 +13,7 @@
 #   => 'hellohello'
 #
 # Like Cucumber, it will raise an error if there is > 1 matching step
-# {DynamicSteps::AmbiguousMatchError} can be rescued if desired.
+# AmbiguousMatchError can be rescued if desired.
 #
 # It also raises an error if no matcher was found
 #
@@ -20,10 +21,6 @@ module Gemmy::Components::DynamicSteps
 
   Gemmy::Patches.refinements.each { |r| using r }
 
-  # A hash mapping regex to proc
-  #
-  attr_reader :steps
-
   # Error raised when a string matches multiple step regexes.
   # It's frequently accidental to come into this situation,
   # and having this check prevents surprise errors.
@@ -75,10 +72,11 @@ module Gemmy::Components::DynamicSteps
     end
   end
 
-  # Searches the keys in @steps for a regex the matches the string.
-  # If one is found, it adds the regex as a key in the results hash.
-  # The value is a hash with two keys: :matches (an array) and :proc
-  #
+  # Searches the keys in @steps for regexes that match the string.
+  # @param string [String]
+  # @return [Hash] where keys are regexes and vals are hashes with signature:
+  #   matches: [Array<String>] the String#match results
+  #   proc: [Proc] the block mapped to the regex
   def find_matching_steps(string)
     matching_steps = steps.reduce({}) do |matching_steps, (regex, proc)|
       match_results = string.match(regex).to_a.tap &:shift

data/lib/gemmy/patches/array_patch.rb

@@ -1,4 +1,4 @@
-# Global patches. Could be applied to Object or Kernel
+# Array patches
 #
 module Gemmy::Patches::ArrayPatch
   # checks if any of the results of an array do not respond truthily

data/lib/gemmy/patches/object_patch.rb

@@ -35,7 +35,7 @@ module Gemmy::Patches::ObjectPatch
   # @param text [String] text to write
   #
   def write(file:, text:)
-    File.open(file, 'w', &:write.with(text))
+    File.open(file, 'w') { |f| f.write text }
   end
 
   # if args[0] (object) is blank, raises args[1] (message)

data/lib/gemmy/patches.rb

@@ -1,13 +1,23 @@
 # Gemmy provides patches for a few of the core classes.
 #
-# For example:
-#   Gemmy::Patches.load(only: [:string])
-#   Gemmy::Patches.load(except: [:symbol, :global])
+# See {Gemmy#load_globally} for how to load these on the root namespace
+# For a refinements-based approach, use this in a class/module definition:
+#
+# Gemmy::Patches.refinements.each { |klass| using klass }
+#
+# Note that there are nuances for how refinements are used. You can't refer to
+# the patches using define_method, for example.
+#
+# See examples/01_using_as_refinement.rb for more info
 #
 module Gemmy::Patches
 
-  def self.refinements
-    core_patches.values
+  def self.refinements(only: nil, except: nil)
+    core_patches.select do |core_klass, patch_klass|
+      return false if only && !only.include?(core_klass)
+      return false if except && except.include?(core_klass)
+      true
+    end.values
   end
 
   def self.core_patches
@@ -19,7 +29,7 @@ module Gemmy::Patches
       Method: Gemmy::Patches::MethodPatch,
       Hash:     Gemmy::Patches::HashPatch,
       Thread: Gemmy::Patches::ThreadPatch,
-    }
+    }.with_indifferent_access
   end
 
 end

data/lib/gemmy/tasks/make_gem.rb

@@ -1,6 +1,6 @@
 # A task to create skeleton structure for a ruby gem
 #
-# Only one method is intended for public use, {Tasks::MakeGem#run}.
+# Only one method is intended for public use, {run}.
 #
 # It takes one argument - the name of the ruby gem.
 #
@@ -10,6 +10,9 @@
 #
 # ├── <name>.gemspec
 # ├── Gemfile
+# ├── reinstall
+# ├── bin
+#   └── <name>
 # └── lib
 #   ├── <name>.rb
 #   └── version.rb
@@ -42,6 +45,8 @@ class Gemmy::Tasks::MakeGem
     create_gemspec_file
     create_gemfile
     create_reinstall_file
+    create_executable
+    puts "directory #{name} has been created".yellow
   end
 
   attr_reader :name, :root_dir, :lib, :version_file, :main_file, :summary,
@@ -50,32 +55,17 @@ class Gemmy::Tasks::MakeGem
 
   private
 
-  # A reinstall file is very helpful for development
-  def create_reinstall_file
-    file_txt = <<-TXT.unindent
-      #!/usr/bin/env ruby
-      puts `gem uninstall -x #{name}`
-      puts `gem build #{name}.gemspec`
-      Dir.glob("./*.gem").each { |path| puts `gem install #{path}` }
-    TXT
-    file_path = "#{root_dir}/reinstall"
-    File.open(file_path, 'w') do |file|
-      file.write file_txt
-    end
-    `chmod a+x #{file_path}`
-  end
-
   # prints usage instructions unless the gem name was specified
   #
   def usage_io
-    usage = <<-TXT.unindent
-      \nUsage: make_gem <name>
-    TXT
-    raise usage if @name.blank?
+    if @name.blank?
+      puts "\nUsage: make_gem <name>"
+      exit
+    end
     self
   end
 
-  # creates a root directory for the gem
+  # Creates a root directory for the gem
   #
   def create_root_dir
     @root_dir = name
@@ -185,5 +175,45 @@ class Gemmy::Tasks::MakeGem
     self
   end
 
+  # A reinstall file is very helpful for development
+  def create_reinstall_file
+    file_txt = <<-TXT.unindent
+      #!/usr/bin/env ruby
+      Dir.glob("./*.gem").each { |path| `rm \#{path}` }
+      puts `gem uninstall -x #{name}`
+      puts `gem build #{name}.gemspec`
+      Dir.glob("./*.gem").each { |path| puts `gem install -f \#{path}` }
+    TXT
+    file_path = "#{root_dir}/reinstall"
+    File.open(file_path, 'w') do |file|
+      file.write file_txt
+    end
+    `chmod a+x #{file_path}`
+    puts "wrote reinstall file".green
+  end
+
+  # Creates an empty gem executable which requires the gem.
+  # This makes it easy to call functions from the ruby codebase.
+  # The Thor CLI library is used, see whatisthor.com
+  def create_executable
+    file_txt = <<-TXT.unindent
+      #!/usr/bin/env ruby
+      require '#{name}'
+      class #{class_name}::CLI < Thor
+        desc "test", "run tests"
+        def test
+          puts "No tests have been wrritten"
+          exit
+        end
+      end
+      #{class_name}::CLI.start ARGV
+    TXT
+    `mkdir #{root_dir}/bin`
+    file_path = "#{root_dir}/bin/#{name}"
+    write(file: "#{file_path}", text: file_txt)
+    `chmod a+x #{file_path}`
+    puts "wrote executable".green
+  end
+
 end
 

data/lib/gemmy/version.rb

@@ -1,3 +1,3 @@
 class Gemmy
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemmyrb
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - max pleaner
@@ -137,5 +137,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: general utils
+summary: Some general ruby language utils, including a gem generator. See http://github.com/maxpleaner/gemmy
+  for more detail
 test_files: []