ignoring 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b3326d681317d030f02b99ea271947e6b441be9
-  data.tar.gz: 527983bd00b456d3d6f6b26d160c154edceaa56e
+  metadata.gz: 9270dab31b4d8bc99f17a6a6e4d3bfeedac4b732
+  data.tar.gz: 384edaaccdba075470e24d20f80473242091faf4
 SHA512:
-  metadata.gz: f78f320d5036711a922adff7f77dbb23853453b772179171515dfeb1e8243229eb61de56189d8ad0c70e27e73627b97877953f52249b15ccec402a258a5316bb
-  data.tar.gz: cea4297c2537de5441ad773d31415a4f8b4371a5e7476b35f0ab5b42a1f2d7064855a4d4f230cbf2ef161412b8a7577d3bc2fa04da2ec38225d9a16ed69669b4
+  metadata.gz: 3cd691caf038ed6c66ceb7a66f4af1fbfb0f9a9c113151931c9c7c2fe14c58095c4bc06439530087c80273be9aaef8857add146c5583a0653e200d6ecdba90e3
+  data.tar.gz: 387a99266910fd758a5c44f3af648dcca068ce619c72e94e08394d724c2dbea519cf2acc15e3030e336dda03d9b12333c68f3d5d3f0d43f3308d55074385d781

data/README.md

@@ -18,12 +18,64 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This tool is realtively simple to use.  You can use either `ignoring` or `gitignore`. For these examples, I will be using `gitignore`.
+
+### Creating a gitignore
+
+Creating a .gitignore file in your currrent directory
+
+    $ gitignore create
+
+Creating a global gitignore (You will be prompted for a location)
+
+    $ gitignore create -g
+    $ gitignore create --global
+
+### Adding to a gitignore
+
+Adding items to the gitignore
+
+    $ gitignore add tmp Gemfile.lock
+    $ gitignore add -g .DS_Store
+    $ gitignore add --global .DS_Store
+
+Adding languages to the gitignore. (These are retrieved from github's gitignores)
+
+    $ gitignore add -l Ruby Rails
+    $ gitignore add -gl Ruby Rails
+    $ gitignore add --global --languages Ruby Rails
+
+### List languages
+
+List languages from github's gitignores
+
+    $ gitignore list
+
+### Show gitignores
+
+Print your local gitignore to STDOUT
+
+    $ gitignore show
+
+Print your global gitignore to STDOUT
+
+    $ gitignore show -g
+    $ gitignore show --global
+
+Print a specific language to STDOUT
+
+    $ gitignore show -l Ruby
+    $ gitignore show --language Ruby
+
+## Future
+
+* Create your own templates
+
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/ignoring/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
+1. Fork it ( http://github.com/kristenmills/ignoring/fork )
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
 5. Create new Pull Request

data/bin/gitignore

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'ignoring'
+
+Ignoring::CLI.start(ARGV)

data/bin/ignoring

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'ignoring'
+
+Ignoring::CLI.start(ARGV)

data/ignoring.gemspec

@@ -21,5 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
 
-  spec.add_dependency "thor", '~>0.19'
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "git", "~> 1.2.8"
+  spec.add_dependency "highline", "~> 1.6"
+  spec.add_dependency "terminal-table", "~> 1.4.5"
 end

data/lib/ignoring/cli.rb

@@ -0,0 +1,32 @@
+require "thor"
+
+# CLI class
+module Ignoring
+  class CLI < Thor
+
+    desc "create", "creates a new gitignore if one doesn't exist in the directory"
+    option :global, type: :boolean, desc: "whether to use global gitignore", aliases: :g
+    def create
+      Helpers::create(options)
+    end
+
+    desc "add [ITEM/LANGUAGE...]", "Adds a new item to the gitignore if it isn't already added"
+    option :global, type: :boolean, desc: "use global gitignore", aliases: :g
+    option :languages, type: :boolean, desc: "get language templates from github", aliases: :l
+    def add(*items)
+      Helpers::add(options, items)
+    end
+
+    desc "list", "lists the different languages available from github/gitignore"
+    def list
+      Helpers::list
+    end
+
+    desc "show", "displays a gitignore"
+    option :global, type: :boolean, desc: "whether to use global gitignore", aliases: :g
+    option :language, desc: "displays gitignore for language from github/gitignore repo", aliases: :l
+    def show
+      Helpers::show(options)
+    end
+  end
+end

data/lib/ignoring/helpers.rb

@@ -0,0 +1,96 @@
+require "fileutils"
+require "octokit"
+require "highline/import"
+require "git"
+require "terminal-table"
+
+module Ignoring
+  module Helpers
+    extend self
+
+    # Logic for creating a gitignore
+    #
+    # @param options the options hash
+    def create(options)
+      if options[:global]
+        file = Git.global_config("core.excludesfile")
+        if file.empty?
+          file = ask("Where would you like your global gitignore? ")
+          Git.global_config("core.excludesfile", file)
+        end
+      else
+        file = '.gitignore'
+      end
+      FileUtils.touch(file)
+    end
+
+    # Logic for adding an item to a gitignore
+    #
+    # @param options the options hash
+    # @param items the items/languages to add
+    def add(options, items)
+      if options[:global]
+        file = Git.global_config("core.excludesfile")
+      else
+        file = ".gitignore" if File.exist?(".gitignore")
+      end
+      if file.empty? or file.nil?
+        puts "No gitignore. run create first." if file.empty?
+      else
+        combined = File.open(file).read.split("\n")
+        if options[:languages]
+          languages = items
+          items = []
+          languages.each do |lang|
+            items += language_array(lang) || []
+          end
+        end
+        items.each { |item| combined << item if !combined.include? item or item.start_with? "#" or item.empty? }
+        File.open(file, "w") do |file|
+          combined.each do |item|
+            file.puts item
+          end
+        end
+      end
+    end
+
+    # Logic for listing the languages
+    def list
+      langs = Octokit.gitignore_templates
+      lang_rows = []
+      langs.each_slice(4) do |group|
+        lang_rows << group
+      end
+      table = Terminal::Table.new(rows: lang_rows)
+      table.style = {border_x: "", border_i: "", border_y: ""}
+      puts table
+    rescue
+      puts "Error gitting language information. You might have reached your rate limit for the hour."
+    end
+
+    # logic for showing gitignores
+    #
+    # @param options the options hash
+    def show(options)
+      if options[:global]
+        file = Git.global_config("core.excludesfile")
+        puts File.read(file) if File.exists?(file)
+      elsif options[:language]
+        puts Octokit.gitignore_template(options[:language])[:source]
+      else
+        puts File.read('.gitignore') if File.exists?('.gitignore')
+      end
+    rescue
+      puts "#{language} is not a valid language."
+    end
+
+    private
+
+    # Helper method for parsing github language template
+    def language_array(language)
+      Octokit.gitignore_template(language)[:source].split("\n")
+    rescue
+      puts "#{language} is not a valid language."
+    end
+  end
+end

data/lib/ignoring/version.rb

@@ -1,3 +1,3 @@
 module Ignoring
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/lib/ignoring.rb

@@ -1,5 +1,7 @@
 require "ignoring/version"
+require "ignoring/helpers"
+require "ignoring/cli"
 
+# Ignoring module
 module Ignoring
-  # Your code goes here...
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ignoring
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Kristen Mills
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,10 +52,54 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
 description: Tool for managing gitignores
 email:
 - kristen@kristen-mills.com
-executables: []
+executables:
+- gitignore
+- ignoring
 extensions: []
 extra_rdoc_files: []
 files:
@@ -64,8 +108,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/gitignore
+- bin/ignoring
 - ignoring.gemspec
 - lib/ignoring.rb
+- lib/ignoring/cli.rb
+- lib/ignoring/helpers.rb
 - lib/ignoring/version.rb
 homepage: https://github.com/kristenmills/ignoring
 licenses: