ignorify 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e419bd3eecf5e8066451ac9fe2f6ad65eaf54879
-  data.tar.gz: 9d7a6aaa75ccf48da42f946b84c7970a3b0a9888
+  metadata.gz: 19f1bb2a3a8d0e2ac4f26e6f92c2edc537c09b68
+  data.tar.gz: 05ecbfd9098740c0c3a303dcdb26d08e409b5962
 SHA512:
-  metadata.gz: c00bb8edc378b3768cd9b851995967961baa8f96c699ce50d2c21ef7c09b069097d023e5dce39eeb5daa0798850e99c4c8eaee09948262588ad2ef79230fe5be
-  data.tar.gz: c80f1f064d5a7bc09bd01749e3778a092d6f0a0dcc23392522c72c8ff0ece1d5412689f24dee3c81dcdb954b081b64e166e9df878982d117bb67b6e6f7a9d88f
+  metadata.gz: cf33051a374cd5cff851441a81f019454b31022508ca127b7f6f2d1c89c28547b691e3713b07f2bdf68fb07bcc3642a011a617669d0c65fdc6cb3fb0d28975e0
+  data.tar.gz: c84e67ba13d8eb255fa0cf111d6156f38cf17f9bb082a392c5da7b1072d532af11657e2bd7f0dd5af1df9ab54e551f4c1ff3afe89f83b3c95000f3c00f9a84c8

data/.travis.yml

@@ -12,7 +12,11 @@ rvm:
 # Install dependencies
 install: bundle install
 
-#Test
+# Test command
 script: rspec
 
+# Turn off notifications
+notifications:
+  email: false
+
 

data/README.md

@@ -5,6 +5,26 @@
 
 A simple command line tool to pull and save .gitignore files!
 
+## TODO
+
+- Peek into .gitignore files before downloading them (v1.2.0)
+
+## Changelog
+
+### v1.1.1 (12-02-2015)
+
+- Add search command to filter files.
+- Check for existing gitignore and prompt to overwrite.
+
+### v1.0.1 (15-01-2015)
+
+- Fix some issues with the Ruby gem install.
+- Changed main executable path to relative.
+
+### v1.0.0 (15-01-2015)
+
+- First release with all core functionality 
+
 ## Installation
 
 Install using gem
@@ -39,6 +59,7 @@ But, if cURL is not installed, it manually grabs by crawling.
 - `list`: Shows a list of all available files.
 - `help`: Shows available commands.
 - `version`: Returns the current version number.
+- `search <filename>`: Searches for a gitignore and returns results.
 - `create <filename>`: Places a .gitignore file in the current directory.
 
 ### Usage
@@ -52,6 +73,8 @@ Fetching gitignore...
 ######################################################################## 100.0%
 .gitignore created
 ```
+If there is an already existing .gitignore in the directory, you may choose to overwrite it.
+If you dont want to, the command will exit without changing any files.
 
 If the file searched for is not available, an error message will be shown.
 

data/bin/ignorify

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-
 require_relative '../lib/ignorify'
 
 Ignorify::Ignorify.start(ARGV)

data/ignorify.gemspec

@@ -22,11 +22,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "codeclimate-test-reporter", "~>0.4", ">= 0.4.5"
-  spec.add_development_dependency "rspec", "~>3.1", ">= 3.1.0"
+  spec.add_development_dependency "rake", "~> 10.0", ">=10.4.2"
+  spec.add_development_dependency "codeclimate-test-reporter", "~>0.4", ">= 0.4.6"
+  spec.add_development_dependency "rspec", "~>3.1", ">= 3.2.0"
   
   spec.add_dependency "thor", "~>0.19", ">= 0.19.1"
-  spec.add_dependency "nokogiri", "~>1.6", ">= 1.6.5"
+  spec.add_dependency "nokogiri", "~>1.6.6.2", ">= 1.6.6"
   spec.add_dependency "colorize", "~>0.7", ">= 0.7.5"
 end

data/lib/ignorify/core.rb

@@ -0,0 +1,95 @@
+require_relative "version"
+require "thor"
+require_relative "util"
+require "colorize"
+
+module Ignorify
+  class Ignorify < Thor
+
+    # Lists all available ignorify commands.
+    # 
+    # Example:
+    #   >> ignorify list
+    #
+    # Prints to stdout.
+    desc "list", "List available .gitignore files."
+    def list
+      $stdout.puts Utils.file_list.keys
+    end
+
+    # Prints the current ignorify version.
+    # 
+    # Example:
+    #   >> ignorify version
+    #
+    # Prints to stdout.
+    desc "version", "Get current ignorify version."
+    def version
+      $stdout.puts VERSION
+    end
+
+    # Downloads the specified .gitignore file.
+    # Saves it to the working directory.
+    #
+    # Example:
+    #   >> ignorify create java
+    #
+    # Arguments:
+    #   name: (String)
+    #
+    # Prints to stdout.
+    desc "create <FILENAME>", "Downloads required .gitignore file."
+    def create(name)
+      file_list = Utils.file_list
+      
+      # Create a file
+      create_file = Proc.new do |file_list|
+        if Utils.create_file(file_list[name])
+          $stdout.puts ".gitignore created".green
+        else
+          $stdout.puts "Error creating .gitignore".red
+        end
+      end
+
+      if file_list.has_key?(name)
+        if Utils.check_existing_gitignore
+          response = ask("There is an already existing .gitignore file.\nDo you wish to overwrite?".red,
+            :limited_to => ["y", "n"])
+
+          case response
+          when "y"
+            create_file.call(file_list)
+          when "n"
+            $stdout.puts "Exiting.."
+            exit 1
+          end
+        else
+          create_file.call(file_list)
+        end
+      else
+        $stdout.puts "File was not found in the git repository".red
+      end
+    end
+
+    # Search for a filename <FILENAME>.
+    # Returns any matches in the gitignore list.
+    # 
+    # Example:
+    #   >> ignorify search ruby
+    #
+    # Arguments:
+    #   term: (String)
+    #
+    # Prints to stdout.
+    desc "search <FILENAME>", "Search for a gitignore and filter results."
+    def search(term)
+      results = Utils.search(term)
+      if results.length > 0
+        $stdout.puts "Available gitignore files:".green
+        $stdout.puts "#{results.join(", ")}"
+      else
+        $stdout.puts "No gitignore for #{term} was found".red
+      end
+    end
+  end
+end

data/lib/ignorify/util.rb

@@ -0,0 +1,118 @@
+require "nokogiri"
+require "open-uri"
+
+module Ignorify
+
+  # Utility class.
+  # Generates file list and downloads gitignores.
+  # Also contians strategies depending on cURL.
+  class Utils
+
+    REPOSITORY_URL = "https://github.com/github/gitignore"
+    REPOSITORY_RAW_URL = "https://raw.githubusercontent.com/github/gitignore/master/"
+    FILENAME = ".gitignore"
+
+    # Get file list from Github repository.
+    # Crawls the github repository.
+    # Generates a hash with lowercase values mapped to crawled values.
+    #
+    # Returns:
+    #   Hash
+    def self.file_list
+      file_list = {}
+      
+      page = Nokogiri::HTML(open(REPOSITORY_URL))
+      page.css('td.content span.css-truncate a').each do |tr|
+        if tr.content.end_with?(FILENAME)
+          trimmed_name = tr.content.chomp(FILENAME)
+          file_list[trimmed_name.downcase] = trimmed_name
+        end
+      end
+      return file_list
+    end
+
+    # Grabs the latest gitignore.
+    # Saves .gitignore.
+    # We check to see if cURL is installed.
+    # If installed, fetch using cURL
+    #
+    # As a fallback, scrape the file.
+    # Arguments:
+    #   name: (String)
+    #
+    # Returns:
+    #   Boolean
+    def self.create_file(name)
+      request_url = REPOSITORY_RAW_URL + name + FILENAME
+      system("curl -V > /dev/null")
+
+      if $? == 0
+        return fetch_using_curl(request_url)
+      else
+        return crawl_and_fetch(request_url)
+      end
+    end
+
+    # Strategy to fetch using cURL.
+    # 
+    # Arguments:
+    #   request_url: (String)
+    #
+    # Returns:
+    #   Boolean
+    def self.fetch_using_curl(request_url)
+      system("echo Fetching gitignore...")
+      file_created = system("curl --progress -o #{FILENAME} #{request_url}")
+      return file_created
+    end
+
+    # Strategy to fetch by crawling the page.
+    #
+    # Arguments:
+    #   request_url: (String)
+    # 
+    # Returns:
+    #   Boolean
+    def self.crawl_and_fetch(request_url)
+      page = Nokogiri::HTML(open(request_url))
+      page_content = file.css('body p').text
+
+      File.open(FILENAME, "w") do |file|
+        file.write(page_content)
+      end
+
+      if File.exist?(FILENAME) && FILENAME.size > 0
+        return true
+      else
+        return false
+      end
+    end
+
+    # Search for a term in the gitignore list.
+    # 
+    # Arguments:
+    #   term: (String)
+    # 
+    # Returns:
+    #   Array
+    def self.search(term)
+      return file_list.keys.grep(/#{term}/)
+    end
+
+    # Check for existing .gitignore.
+    #
+    # Returns:
+    #   Boolean
+    #
+    def self.check_existing_gitignore
+      if File.exist?(FILENAME) && FILENAME.size > 0
+        return true
+      else
+        return false
+      end
+    end
+
+    private_class_method :fetch_using_curl
+    private_class_method :crawl_and_fetch
+  end
+end

data/lib/ignorify/version.rb

@@ -1,3 +1,3 @@
 module Ignorify
-  VERSION = "1.0.1"
+  VERSION = "1.1.1"
 end

data/lib/ignorify.rb

@@ -1,55 +1 @@
-require "ignorify/version"
-require "thor"
-require_relative "util"
-require "colorize"
-
-module Ignorify
-  class Ignorify < Thor
-
-    # Lists all available ignorify commands.
-    # 
-    # Example:
-    #   >> ignorify list
-    #
-    # Prints to stdout.
-    desc "list", "List available .gitignore files."
-    def list
-      $stdout.puts Utils.file_list.keys
-    end
-
-    # Prints the current ignorify version.
-    # 
-    # Example:
-    #   >> ignorify version
-    #
-    # Prints to stdout.
-    desc "version", "Get current ignorify version."
-    def version
-      $stdout.puts VERSION
-    end
-
-    # Downloads the specified .gitignore file.
-    # Saves it to the working directory.
-    #
-    # Example:
-    #   >> ignorify create java
-    #
-    # Arguments:
-    #   name: (String)
-    #
-    # Prints to stdout.
-    desc "create <FILENAME>", "Downloads required .gitignore file"
-    def create(name)
-      file_list = Utils.file_list
-      if file_list.has_key? name
-        if Utils.create_file(file_list[name])
-          $stdout.puts ".gitignore created".green
-        else
-          $stdout.puts "Error creating .gitignore".red
-        end
-      else
-        $stdout.puts "File was not found in the git repository".red
-      end
-    end
-  end
-end
+require 'ignorify/core'

data/spec/ignorify_spec.rb

@@ -4,6 +4,10 @@ require_relative '../lib/ignorify/version'
 require "colorize"
 
 describe Ignorify::Ignorify do
+  before(:all) do
+    FileUtils.rm(".gitignore")
+  end
+
   describe "#list" do
     it "should list all available .gitignore files" do
       file_list = Ignorify::Utils.file_list.keys.join("\n") + "\n"
@@ -34,6 +38,19 @@ describe Ignorify::Ignorify do
     end
   end
 
+  describe "#search" do
+    it "should search the list for a term" do
+      args = %w[search ruby]
+      search_task = capture(:stdout) { Ignorify::Ignorify.start(args) }
+      expect(search_task).to eq("Available gitignore files:".green + "\n" + "ruby\n")
+    end
+    it "should show an error if a file cannot be found" do
+      args = %w[search xxctgft]
+      search_task = capture(:stdout) { Ignorify::Ignorify.start(args) }
+      expect(search_task).to eq("No gitignore for xxctgft was found".red + "\n")
+    end
+  end
+
   # Teardown modified .gitignore
   after(:all) do
     FileUtils.cp('spec/original/gitignore', '.gitignore')

data/spec/util_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require_relative '../lib/ignorify/util'
+require "colorize"
+
+describe Ignorify::Utils do
+  describe "#file_list" do
+    files = Ignorify::Utils.file_list
+    it "should return a Hash" do
+      expect(files).to be_an_instance_of(Hash)
+    end
+    it "should have a length greater than zero" do
+      expect(files.length).to be > 0
+    end
+  end
+
+  describe "#create_file" do
+    it "should return true when a valid file is passed" do
+      file_created = Ignorify::Utils.create_file("ruby")
+      expect(file_created).to be true
+    end
+  end
+
+  describe "#search" do
+    results = Ignorify::Utils.search("ruby")
+    it "should return results for a term" do
+      expect(results).to eq(["ruby"])
+    end
+    it "should return an Array" do
+      expect(results).to be_an_instance_of(Array)
+    end
+    it "should return an empty array for an invalid term" do
+      expect(Ignorify::Utils.search("xrbgt").length).to eq(0)
+    end
+  end
+
+  # Teardown modified .gitignore
+  after(:all) do
+    FileUtils.cp('spec/original/gitignore', '.gitignore')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ignorify
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - vivangkumar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -47,7 +53,7 @@ dependencies:
         version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: 0.4.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +63,7 @@ dependencies:
         version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: 0.4.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +73,7 @@ dependencies:
         version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -77,7 +83,7 @@ dependencies:
         version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -104,20 +110,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.6.2
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.5
+        version: 1.6.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.6.2
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.5
+        version: 1.6.6
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -158,11 +164,13 @@ files:
 - bin/ignorify
 - ignorify.gemspec
 - lib/ignorify.rb
+- lib/ignorify/core.rb
+- lib/ignorify/util.rb
 - lib/ignorify/version.rb
-- lib/util.rb
 - spec/ignorify_spec.rb
 - spec/original/gitignore
 - spec/spec_helper.rb
+- spec/util_spec.rb
 homepage: https://github.com/vivangkumar/ignorify
 licenses:
 - MIT
@@ -191,3 +199,4 @@ test_files:
 - spec/ignorify_spec.rb
 - spec/original/gitignore
 - spec/spec_helper.rb
+- spec/util_spec.rb

data/lib/util.rb

@@ -1,67 +0,0 @@
-require "nokogiri"
-require "open-uri"
-
-module Ignorify
-
-  # Utility class.
-  # Generates file list and downloads gitignores.
-  class Utils
-
-    REPOSITORY_URL = "https://github.com/github/gitignore"
-    REPOSITORY_RAW_URL = "https://raw.githubusercontent.com/github/gitignore/master/"
-    FILENAME = ".gitignore";
-
-    # Get file list from Github repository.
-    # Crawls the github repository.
-    # Generates a hash with lowercase values mapped to crawled values.
-    #
-    # Returns:
-    #   Hash
-    def self.file_list
-      file_list = {}
-      
-      page = Nokogiri::HTML(open(REPOSITORY_URL))
-      page.css('td.content span.css-truncate a').each do |tr|
-        if tr.content.end_with?(FILENAME)
-          trimmed_name = tr.content.chomp(FILENAME)
-          file_list[trimmed_name.downcase] = trimmed_name
-        end
-      end
-      return file_list
-    end
-
-    # Grabs the latest gitignore.
-    # Saves .gitignore.
-    # We check to see if cURL is installed.
-    #
-    # As a fallback, scrape the file.
-    # Arguments:
-    #   name: (String)
-    #
-    # Returns:
-    #   Boolean
-    def self.create_file(name)
-      request_url = REPOSITORY_RAW_URL + name + FILENAME
-      system("curl -V > /dev/null")
-
-      if $? == 0
-        system("echo Fetching gitignore...")
-        file_created = system("curl --progress -o #{FILENAME} #{request_url}")
-        return file_created
-      else
-        file = Nokogiri::HTML(open(request_url))
-        file_content = file.css('body p').text
-
-        File.open(FILENAME, "w") do |file|
-          file.write(file_content)
-        end
-
-        if File.exist?(FILENAME) && FILENAME.size > 0
-          return true
-        else
-          return false
-        end
-      end
-    end
-  end
-end