ignore-it 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe4f3fcd1823b63622f37773342d0f190a6b1da199eace1cd08c15feec633295
-  data.tar.gz: eca95760a611df332ca4da415e78311d148ca76804c6ab7281a7f335f682d0b9
+  metadata.gz: 80d9566a34fc947b8be73b0c0c807829ee5a610cf4f07b9c078ef88532f4256d
+  data.tar.gz: 731a3c6d125d0b3a3e8654410788dd8b257ab9812397c3d4f7dc8cb4aea6dc1e
 SHA512:
-  metadata.gz: 403f70e0f8030520a8ce81d1faefaf46fcf3aebf2c49e2e5ad3cec1050dd588f2f00fe1b82f739fc4489c2c14117cceb44d7cd135c94a586c48755a1477d5f70
-  data.tar.gz: 15616d052cacb118738549b0a58a4a68d09ae9b64be2e709010295d7c19c685812086032050abfb2b8611e45261a02ebed7a048e4cc893329a71039b6abe139b
+  metadata.gz: 35a98c0914b2b4213b45353fdfa11b396b383cd78fd467a228f5073d8ae792c538a72130c5c60ddce176648a1e6237d7bf50596f31ca549ce0615cc099115042
+  data.tar.gz: 93e85ef86fab76aa03bf1337151261829815c313a373497fa28c6b5a262580278dc14a02ddd941c51e671c463066f228b634706dae71d45d1779add536ec86cd

data/bin/ignore-it

@@ -3,5 +3,7 @@
 require 'optparse'
 require "ignore_it"
 
-tool = IgnoreIt::Main.new
-tool.start
+# tool = IgnoreIt::Main.new
+# tool.start
+tool = IgnoreIt::CLI
+tool.start(ARGV)

data/default_config.yml

@@ -0,0 +1,8 @@
+########################
+# CONFIG for ignore-it #
+########################
+
+# Set ABSOLUTE path to the directory where own gitignore files are stored
+# Default path is ~/.ignore-it/gitignores
+# OPTIONS: "default", "absolute_path"
+own_gitignore_path: "default"

data/lib/ignore_it.rb

@@ -1,42 +1,80 @@
+# frozen_string_literal: true
 require 'net/http'
 require 'json'
 require 'colorize'
 require 'readline'
 require 'ignore_it/list'
+require 'ignore_it/config'
 require 'ignore_it/creator'
+require 'thor'
 
 module IgnoreIt
-  class Main
-    # constructor
-    def initialize
-      @url = "https://www.toptal.com/developers/gitignore/api/list?format=json"
-      @options = {}
-      @list = List.new
+  class CLI < Thor
+    def initialize(*args)
+      super
+      @config = Config.new
       @creator = Creator.new
+      @list = List.new
+      $glob_settings[:output] = "./.gitignore"
     end
 
-    def start
+    class_options force: :boolean, output: :string
 
-      ARGV << '-h' if ARGV.empty?
+    desc "add [templateName]", "Select gitignore template to create a .gitignore file
+    or add a template to an existing .gitignore file"
+    def add(*templateName)
+      if options[:output]
+        return false unless @creator.check_output_path(options[:output])
+        $glob_settings[:output] = if options[:output][-1] == '/'
+          options[:output] + '.gitignore'
+        else
+          options[:output] + '/.gitignore'
+        end
+      end
+      if options[:force]
+        $glob_settings[:force] = true
+      end
+      templateName.each do |name|
+        name = name.downcase
+        if @list.check_list(name)
+          @creator.create_api_ignore(name)
+        else
+          puts "The template #{name} you tried to fetch does not exist".colorize(:red)
+          puts "Please checkout the available templates with " + "ignore-it list".colorize(:green)
+        end
+      end
+    end
 
-      OptionParser.new do |parser|
-        parser.banner = "How to Use ignore-it: Pass one of the following options: e.g => ignore-it -f csharp"
-        parser.on(
-          "-f ", "--file FILE", "Select gitignore template to fetch"
-        ) do |file|
-          file = file.downcase
-          if @list.check_list(file)
-            @creator.create_ignore(file)
-          else
-            puts "The template you tried to fetch does not exist".colorize(:red)
-            puts "Please checkout the available templates with " + "ignore-it -l".colorize(:green)
-          end
-          # @options[:file] = true
+    desc "own [fileName]", "Select user-created template from the folder specified in ~/.ignore-it/config.yml. Default is ~/.ignore-it/gitignores/."
+    def own(*fileName)
+      if options[:output]
+        return false unless @creator.check_output_path(options[:output])
+        $glob_settings[:output] = if options[:output][-1] == '/'
+          options[:output] + '.gitignore'
+        else
+          options[:output] + '/.gitignore'
         end
-        parser.on("-l", "--list", "Show List of available .gitignore entries") do
-          @list.show_list
+      end
+      if options[:force] == true
+        $glob_settings[:force] = true
+      end
+      fileName.each do |name|
+        if @list.check_own_files(name)
+          @creator.create_own_ignore(name)
+        else
+          puts "The template #{name} you tried to create does not exist".colorize(:red)
+          puts "The following templates are available:".colorize(:red)
+          @list.show_own_files
         end
-      end.parse!
+      end
+    end
+
+    desc "list", "Show List of available .gitignore entries"
+    def list
+      puts "---- Available templates from gitignore.io: ----"
+      @list.show_list
+      puts "---- Available user templates (see ~/.ignore-it/config.yml) ----"
+      @list.show_own_files
     end
   end
 end

data/lib/ignore_it/config.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require 'yaml'
+
+module IgnoreIt
+  class Config
+    attr_accessor :config
+
+    def initialize
+      $glob_settings = {}
+      create_initial_config
+      load_config
+    end
+
+    def print_config
+      puts $glob_settings.to_yaml
+    end
+
+    # Load user config from config directory
+    def load_config
+      Dir.chdir(Dir.home) do
+        if File.exist?(".ignore-it/config.yml")
+          $glob_settings = YAML.load_file(".ignore-it/config.yml")
+        else
+          puts "Failed to load user config in ~/.ignore-it/config.yml".colorize(:red)
+          puts "Defaulting...".colorize(:red)
+          $glob_settings = YAML.load_file(find_gem_root + "/default_config.yml")
+        end
+      end
+    end
+
+    # Find the gems install directory
+    def find_gem_root
+      spec = Gem::Specification.find_by_name("ignore-it")
+      spec.gem_dir
+    end
+
+    # Create initial user config and folders in home directory
+    def create_initial_config
+      Dir.chdir(Dir.home) do
+        unless Dir.exist?(".ignore-it")
+          Dir.mkdir(".ignore-it")
+          Dir.mkdir(".ignore-it/gitignores")
+          defaultConfig = File.read(find_gem_root + "/default_config.yml")
+          File.write(".ignore-it/config.yml", defaultConfig)
+        end
+      end
+    end
+  end
+end

data/lib/ignore_it/creator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # lib/creation.rb
 require 'ignore_it/list'
 require 'readline'
@@ -6,55 +7,85 @@ require 'colorize'
 module IgnoreIt
   class Creator
     def initialize
-      list = List.new
-      @jsonResponse = list.jsonResponse
+      @list = List.new
+      @jsonResponse = @list.jsonResponse
     end
 
-    # Code here
-    def create_ignore(name)
-      template = @jsonResponse[name]
-      contents = template["contents"]
-
+    def create_file(contents, name)
       puts "Creating .gitignore for " + name.colorize(:green)
-
-      if File.exist?(".gitignore")
-        # Store the state of the terminal
-        sttySave = %x(stty -g).chomp
-        overwrite = false
-
-        begin
-          puts "File already exists! Overwrite? [y/n]?"
-          while (line = Readline.readline('> ', true).downcase)
-            # if (line.empty? or line != "y" or line != "n")
-
-            if line == "y"
-              overwrite = true
-              break
-            # puts "yo"
-            elsif line == "n"
-              break
-            # puts "ney"
-            elsif (line != "y") || (line != "n")
-              puts "Please provide a correct format (y or n)".colorize(:red)
-              # puts "wut"
+      unless $glob_settings[:force]
+        if File.exist?($glob_settings[:output])
+          sttySave = %x(stty -g).chomp # Store the state of the terminal
+          overwrite = false
+          append = false
+          begin
+            puts "File" + " .gitignore ".colorize(:yellow) + "already exists!"
+            puts "Overwrite or append? [y => yes | a => append | n => no]?"
+            while (line = Readline.readline('> ', true).downcase)
+              if line == "y"
+                overwrite = true
+                break
+              elsif line == "n"
+                break
+              elsif line == "a"
+                append = true
+                break
+              elsif (line != "y") || (line != "n") || (line != "a")
+                puts "Please provide a correct format (y or n)".colorize(:red)
+              end
             end
+          rescue Interrupt
+            system('stty', sttySave) # Restore
+            exit
           end
-        rescue Interrupt => e
-          system('stty', sttySave) # Restore
-          exit
-        end
 
-        if overwrite
-          File.write("./.gitignore", contents)
-          puts ".gitignore has been created!".colorize(:green)
+          if overwrite
+            File.write($glob_settings[:output], contents)
+            puts ".gitignore has been created!".colorize(:green)
+          elsif append
+            gitignoreContents = File.read($glob_settings[:output])
+            puts "Adding .gitignore content from " + name.colorize(:green) + " to existing .gitignore File"
+            gitignoreContents += contents
+            File.write($glob_settings[:output], gitignoreContents)
+          else
+            puts ".gitignore has NOT been created! Terminating process!".colorize(:red)
+          end
         else
-          puts ".gitignore has NOT been created! Terminating process!".colorize(:red)
+          File.write($glob_settings[:output], contents)
+          puts ".gitignore has been created!".colorize(:green)
         end
-
       else
-        File.write("./.gitignore", contents)
+        File.write($glob_settings[:output], contents)
         puts ".gitignore has been created!".colorize(:green)
       end
     end
+
+    def create_own_ignore(name)
+      contents = ""
+      if $glob_settings["own_gitignore_path"] == "default"
+        Dir.chdir(Dir.home) do
+          contents = File.read(".ignore-it/gitignores/" + name)
+        end
+      else
+        Dir.chdir($glob_settings["own_gitignore_path"]) do
+          contents = File.read(name)
+        end
+      end
+      create_file(contents, name)
+    end
+
+    def create_api_ignore(name)
+      template = @jsonResponse[name]
+      contents = template["contents"]
+      create_file(contents, name)
+    end
+
+    def check_output_path(name)
+      if Dir.exist?(name)
+        true
+      else
+        puts "The Output Path you provided does currently not exist, please create it manually before using --output".colorize(:red)
+      end
+    end
   end
 end

data/lib/ignore_it/list.rb

@@ -10,10 +10,44 @@ module IgnoreIt
       @url = "https://www.toptal.com/developers/gitignore/api/list?format=json"
       @response = Net::HTTP.get(URI(@url))
       @jsonResponse = JSON.parse(@response)
+      load_own_files
     end
 
-    attr_reader :jsonResponse
+    attr_reader :jsonResponse, :ownFiles
 
+    # Load own gitignore templates from the directory specified in the config file
+    def load_own_files
+      @ownFiles = if $glob_settings["own_gitignore_path"] == "default"
+        Dir.chdir(Dir.home) do
+          Dir.entries(".ignore-it/gitignores/").select do |files|
+            files unless files =~ /^..?$/ # some regex magic to remove "." and ".."
+          end
+        end
+      else
+        Dir.chdir($glob_settings["own_gitignore_path"]) do
+          Dir.entries(".").select do |files|
+            files unless files =~ /^..?$/
+          end
+        end
+      end
+    end
+
+    # Check if the requested template exists
+    def check_own_files(file)
+      if @ownFiles.include?(file)
+        exists = true
+      end
+      exists
+    end
+
+    # Print all own gitignore templates
+    def show_own_files
+      @ownFiles.each do |file|
+        puts file
+      end
+    end
+
+    # Check the API List
     def check_list(file)
       exists = false
 
@@ -27,9 +61,9 @@ module IgnoreIt
       exists
     end
 
+    # Print all gitignore templates fetched by the API
     def show_list
       sortedArray = @jsonResponse.sort
-
       sortedArray.each do |entry|
         puts entry.first
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ignore-it
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Felix Macho
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-07 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.3.0
+        version: 11.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.3.0
+        version: 11.2.2
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -53,15 +53,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
-description: 
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: |2
+      Feel it's sometimes cumbersome to browse to a website, only to download a .gitignore?
+      We've got your back!
+      ignore-it is a small cli tool, which helps in fetching and creating .gitignore files from gitignore.io or local custom templates.
+      We try to keep runtime dependencies as small as possible and are using mostly standard ruby libraries.
 email: 
 executables:
 - ignore-it
 extensions: []
 extra_rdoc_files: []
 files:
+- "./default_config.yml"
 - bin/ignore-it
 - lib/ignore_it.rb
+- lib/ignore_it/config.rb
 - lib/ignore_it/creator.rb
 - lib/ignore_it/list.rb
 homepage: 
@@ -87,5 +107,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: ignore-it your command line tool for fetching .gitignore files
+summary: ignore-it your command line tool for creating .gitignore files
 test_files: []