dev_oops 0.2.0.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32ee75a41461d7793d454367ce09a989c796df9a50c861d27795a5864e74a9ca
-  data.tar.gz: 0351c14d9116a45119a773c69fd1dc493837a48b06366d3b4a2977c34428673a
+  metadata.gz: c0756192a829fa282dfacaa2be870bd6c97102ce76b197e4afb7ed55a290d805
+  data.tar.gz: '058272644fb82265682974985c453e1976e0788de6e82c7192170eeeb5450390'
 SHA512:
-  metadata.gz: 989bb33a56ad674bdfc1a47719648b5111668af45d160c2e971113ca56ccc7dc27c8862962b7c9cae20700f3c2b6e5ff3853239f6a621c96afe066c2871ddc70
-  data.tar.gz: 4f967de470975239f896074dea2bf86869647dd3d0f3820f503a0e195539446f99b3e0cdcbc5b5143a884889e4944e20d8d94a07c51a39db1c45a5a14affe1eb
+  metadata.gz: 1a501ce812965c99a54024bce23b7bd7e61b01679644085289f665b9339cf59c8c3c50e0c15c752a24af409cbd82c8107a5f38b20509e26f6afa6caedac2ee16
+  data.tar.gz: 222ecba063dac5454fa32592b2cef2224c266cbe96473f69c064e73599f31e5e34e2907c2132609ea26d63b0c923cb58f88bc1424747159b66f8917f0403f1f2

data/README.md

@@ -4,7 +4,21 @@ This is a gem to help you manage all the scripts and repetitive commands you hav
 
 ## Installation
 
-    $ gem install dev_oops && dev_oops install
+There's 2 main ways to install and use this gem.
+
+### Global install
+
+    $ gem install dev_oops
+
+### Bundler way
+
+Add this gem to your Gemfile
+
+```
+gem 'dev_oops'
+```
+
+Then `bundle install`
 
 ## Usage
 
@@ -51,13 +65,31 @@ dev_oops help hello # =>
 #                               # Default: Pierre
 ```
 
-### Commands
+### Script locations
+
+By default this gem will use the `$HOME/.dev_oops` directory to install configs and scripts.
 
-Which editor will be opened by the gem
+This gem will also try to find every `dev_oops` directory between the current directory and home and look for scripts in them.
 
-#### install
+If there's a name collision, the closest to `current_dir` will be chosen.
 
-`dev_oops install` Will create the base directory needed for storing your scripts.
+This search will also be done while editing or removing a script. It will use:
+
+1. The existing script with the same name
+2. Or, the `./dev_oops` directory if exists
+3. Or, the `$HOME/.dev_oops` directory otherwise
+
+All `edit`, `edit_sh` and `rm` commands (see lower) have a `--global` or `-g` option to bypass the search and use the `$HOME/.dev_oops` directory.
+
+#### Creating a local directory
+
+`bundle exec dev_oops local_install`.
+
+This will create a `./dev_oops` directory.
+
+### Commands
+
+Which editor will be opened by the gem is dictated by the `$EDITOR` environment variable.
 
 #### edit
 
@@ -111,6 +143,8 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+Be carefull, in dev your directory will be detected as a local directory (because of its name). Do not remove the "package" script.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/zaratan/dev_oops. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/zaratan/dev_oops/blob/master/CODE_OF_CONDUCT.md).

data/lib/dev_oops.rb

@@ -13,9 +13,6 @@ loader.setup # ready!
 module DevOops
   class Error < StandardError
   end
-
-  # TODO Refactor
-  CONFIG_DIR = "#{ENV['HOME']}/.dev_oops"
 end
 
 loader.eager_load

data/lib/dev_oops/commands/edit_script.rb

@@ -9,10 +9,25 @@ module DevOops
       end
 
       argument :script_name
+      class_option :global,
+                   desc: 'force the script to be global',
+                   aliases: ['g'],
+                   type: :boolean
+
+      def self.banner
+        "#{$PROGRAM_NAME} edit SCRIPT_NAME"
+      end
+
       def edit
-        path = "#{CONFIG_DIR}/#{script_name}.json"
+        script_dir =
+          if options[:global]
+            ScriptsLoader::GLOBAL_DIR
+          else
+            ScriptsLoader.script_dir(script_name)
+          end
+        path = "#{script_dir}/#{script_name}.json"
         template 'templates/empty_script.tt', path unless File.exist?(path)
-        system("#{ENV['EDITOR'] || 'vim'} #{CONFIG_DIR}/#{script_name}.json")
+        system("#{ENV['EDITOR'] || 'vim'} #{path}")
       end
     end
   end

data/lib/dev_oops/commands/edit_script_sh.rb

@@ -4,12 +4,31 @@ module DevOops
     class EditScriptSh < Thor::Group
       include Thor::Actions
 
+      def self.source_root
+        "#{File.dirname(__FILE__)}/../../../"
+      end
+
       argument :script_name
+      class_option :global,
+                   desc: 'force the script to be global',
+                   aliases: ['g'],
+                   type: :boolean
+
+      def self.banner
+        "#{$PROGRAM_NAME} edit_sh SCRIPT_NAME"
+      end
+
       def edit
-        path = "#{CONFIG_DIR}/#{script_name}.sh"
-        FileUtils.touch(path) unless File.exist?(path)
+        script_dir =
+          if options[:global]
+            ScriptsLoader::GLOBAL_DIR
+          else
+            ScriptsLoader.script_dir(script_name)
+          end
+        path = "#{script_dir}/#{script_name}.sh"
+        create_file(path) unless File.exist?(path)
         FileUtils.chmod(0o750, path)
-        system("#{ENV['EDITOR'] || 'vim'} #{CONFIG_DIR}/#{script_name}.sh")
+        system("#{ENV['EDITOR'] || 'vim'} #{path}")
       end
     end
   end

data/lib/dev_oops/commands/local_install.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module DevOops
+  module Commands
+    class LocalInstall < Thor::Group
+      def install
+        return if Dir.exist?('./dev_oops')
+
+        FileUtils.mkdir './dev_oops'
+      end
+    end
+  end
+end

data/lib/dev_oops/commands/remove_script.rb

@@ -2,16 +2,33 @@
 module DevOops
   module Commands
     class RemoveScript < Thor::Group
+      include Thor::Actions
+
+      def self.source_root
+        "#{File.dirname(__FILE__)}/../../../"
+      end
+
       argument :script_name, desc: 'name of the script'
+      class_option :global,
+                   desc: 'force the script to be global',
+                   aliases: ['g'],
+                   type: :boolean
 
-      def remove_sh
-        return unless File.exist?("#{CONFIG_DIR}/#{script_name}.sh")
-        FileUtils.remove "#{CONFIG_DIR}/#{script_name}.sh"
+      def self.banner
+        "#{$PROGRAM_NAME} rm SCRIPT_NAME"
       end
 
       def remove_json
-        return unless File.exist?("#{CONFIG_DIR}/#{script_name}.json")
-        FileUtils.remove "#{CONFIG_DIR}/#{script_name}.json"
+        script_dir =
+          if options[:global]
+            ScriptsLoader::GLOBAL_DIR
+          else
+            ScriptsLoader.script_dir(script_name)
+          end
+        json_path = "#{script_dir}/#{script_name}.json"
+        sh_path = "#{script_dir}/#{script_name}.sh"
+        remove_file json_path if File.exist?(json_path)
+        remove_file sh_path if File.exist?(sh_path)
       end
     end
   end

data/lib/dev_oops/runner.rb

@@ -4,6 +4,9 @@ module DevOops
     include Thor::Actions
     REGISTERED_CLASS_METHODS = {} # rubocop:disable Style/MutableConstant
 
+    CONFIG_DIR = "#{ENV['HOME']}/.dev_oops"
+    FileUtils.mkdir CONFIG_DIR unless Dir.exist?(CONFIG_DIR)
+
     def self.source_root
       "#{File.dirname(__FILE__)}/.."
     end
@@ -28,21 +31,22 @@ module DevOops
       'edit SCRIPT_NAME',
       'Edit a script config'
     )
+
     register(
       Commands::EditScriptSh,
       'edit_sh',
       'edit_sh SCRIPT_NAME',
       'Edit the script bash'
     )
-    register(Commands::RemoveScript, 'rm', 'rm SCRIPT_NAME', 'Remove a script')
 
-    # contents of the Thor class
-    desc 'install', 'Create the neccesary directory for the gem'
-    def install
-      return if Dir.exist?(CONFIG_DIR)
+    register(Commands::RemoveScript, 'rm', 'rm SCRIPT_NAME', 'Remove a script')
 
-      FileUtils.mkdir CONFIG_DIR
-    end
+    register(
+      Commands::LocalInstall,
+      'install',
+      'install',
+      'Create the neccesary local directory for the gem'
+    )
 
     def help(subcommand = nil)
       if subcommand && respond_to?(subcommand)

data/lib/dev_oops/scripts_loader.rb

@@ -1,33 +1,62 @@
 # frozen_string_literal: true
 module DevOops
   module ScriptsLoader
-    FORBIDDEN_NAMES = %w[help install edit edit_sh rm].freeze
+    FORBIDDEN_NAMES = %w[help install edit edit_sh rm local_install].freeze
+    GLOBAL_DIR = "#{Dir.home}/.dev_oops"
     ScriptConfig =
-      Struct.new(:name, :desc, :usage, :script_location, :args) do
-        def self.create(script_name, script_location, json_config)
+      Struct.new(:name, :desc, :usage, :script_location, :args, :dir) do
+        def self.create(script_name, script_location, json_config, dir)
           new(
             script_name,
             json_config['desc'] || 'Missing description',
             "#{script_name} #{json_config['usage'] || ''}",
             script_location,
-            json_config['args']
+            json_config['args'],
+            dir
           )
         end
       end
 
+    def self.find_dev_oops_dirs
+      [
+        GLOBAL_DIR,
+        *Dir.pwd.gsub("#{Dir.home}/", '').split('/').reduce(
+          []
+        ) { |res, new_dir| [*res, "#{res.last}/#{new_dir}"] }.map do |dir|
+          "#{Dir.home}#{dir}/dev_oops"
+        end.select { |dir| Dir.exist?(dir) }
+      ]
+    end
+
     def self.load
-      Dir
-        .glob("#{CONFIG_DIR}/*.json")
-        .map do |filename|
-          script_location = filename.gsub(/\.json$/, '.sh')
-          script_location = '' unless File.exist?(script_location)
-          json_config = nil
-          File.open(filename) { |file| json_config = JSON.parse(file.read) }
-          script_name =
-            %r{(?<script_name>[^/]+).json$}.match(filename)['script_name']
-
-          ScriptConfig.create(script_name, script_location, json_config)
+      find_dev_oops_dirs.flat_map do |dir|
+        Dir.glob("#{dir}/*.json")
+      end.map do |filename|
+        script_location = filename.gsub(/\.json$/, '.sh')
+        script_location = '' unless File.exist?(script_location)
+        json_config = nil
+        File.open(filename) { |file| json_config = JSON.parse(file.read) }
+        script_name = File.basename(filename, '.json')
+
+        ScriptConfig.create(
+          script_name,
+          script_location,
+          json_config,
+          File.dirname(filename)
+        )
+      end.reverse.reduce([]) do |res, script_config|
+        if res.any? { |script_c| script_c.name == script_config.name }
+          res
+        else
+          [*res, script_config]
         end
+      end
+    end
+
+    def self.script_dir(script_name)
+      scripts = self.load
+      scripts.find { |script| script.name == script_name }&.dir ||
+        Dir.exist?("#{Dir.pwd}/dev_oops") && "#{Dir.pwd}/dev_oops" || GLOBAL_DIR
     end
 
     def self.build_action(config)

data/lib/dev_oops/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DevOops
-  VERSION = '0.2.0.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dev_oops
 version: !ruby/object:Gem::Version
-  version: 0.2.0.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Denis <Zaratan> Pasin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-03 00:00:00.000000000 Z
+date: 2021-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -195,6 +195,7 @@ files:
 - lib/dev_oops.rb
 - lib/dev_oops/commands/edit_script.rb
 - lib/dev_oops/commands/edit_script_sh.rb
+- lib/dev_oops/commands/local_install.rb
 - lib/dev_oops/commands/remove_script.rb
 - lib/dev_oops/runner.rb
 - lib/dev_oops/scripts_loader.rb