gitignores 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb7e045f09437bc70d6699a4b5c684084d483566
-  data.tar.gz: d0e705d18c9a1aa58df65ee7f869bb0b9bb02d4c
+  metadata.gz: 0edda6b894e24e50cafe41003380171ab0157e65
+  data.tar.gz: 953d0f542005a7a3ca37dc0bb35f4892f83455d1
 SHA512:
-  metadata.gz: ac6cda88633bb487925c1b4801709a144294014a78bdfcada74318dc45646de2367ea8ecca9dafe6443240ddf935067f4826e9aac2ffc278f0c3df9fa4db30f2
-  data.tar.gz: aa7f3a026d02acbecae90c02c34f1108dfd49d42031bb7ad64bd4431df2f6db75a6c098043e8ba5569259cbdbca7d1ec8faec92e105bc0ccc87a1dc5ad76b3e9
+  metadata.gz: 7f6b60527d67e26f41e1160e8a6efa7c44b27fd89f5af17a8dbd0d41fa42e399174fde330785493cec9f2eabf1b71d4da4cfacce89ffbb332a54853ce80e816e
+  data.tar.gz: 003054f16f0868964e2a8275339fc55acb3e011f3d9d85f87aff73f9cb2e8c5e77c58b13ffa33426e5427fa225f2d1d7cdd991e933c73f40be32f88dd40cebb4

data/.gitignore

@@ -0,0 +1,33 @@
+
+# Ruby
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.0.3 (2015-05-25)
+
+Features:
+
+  - more details in usage
+  - "update" command as an easy way to simply update the gitignores directory
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    gitignores (0.1.0)
+      gli (= 2.13.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    gli (2.13.3)
+    json (1.8.3)
+    rake (10.4.2)
+    rdoc (4.2.0)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gitignores!
+  rake
+  rdoc
+  rspec

data/README.md

@@ -10,15 +10,15 @@ Tool for building a .gitignore from community templates at [github/gitignore](ht
 
 **add** append a list of .gitignores to the `.gitignore` in the current directory. Example:
 
-    gitignores add Java IntelliJ Eclipse
+    gitignores add Java JetBrains Eclipse
 
-Adds gitignores for Java, IntelliJ, Eclipse to CURRENT_DIR/.gitignore
+Adds gitignores for Java, JetBrains, Eclipse to `CURRENT_DIR/.gitignore`
 
-**show** prints a concatenation of .gitignores to std_out
+**show** prints a concatenation of .gitignores to standard out
 
-    gitignores show Java IntelliJ Eclipse
+    gitignores show Java JetBrains Eclipse
 
-Prints gitignores for Java, IntelliJ, Eclipse to standard out
+Prints gitignores for Java, JetBrains, Eclipse to standard out
 
 **list** prints a list of available gitignores
 

data/README.rdoc

@@ -0,0 +1,23 @@
+= gitignores - .gitignore builder
+
+Author::  Johnathan Gilday (me@johnathangilday.com)
+Copyright:: Copyright (c) 2013 Johnathan Gilday
+
+
+License:: apache, see LICENSE.txt
+
+
+
+Tool for building a .gitignore from community templates at {github/gitignore}(https://github.com/github/gitignore)
+
+== Links
+
+* {Source on Github}[https://github.com/gilday/gitignore-builder]
+
+== Install
+
+gem install gitignores
+
+== Examples
+
+gitignores add Java JetBrains

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+CLEAN << 'tmp'
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'gitignores'
+end
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+end
+
+spec = eval(File.read('gitignores.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+
+task :default => [:spec]

data/bin/gitignores

@@ -1,60 +1,102 @@
 #!/usr/bin/env ruby
-
-require 'optparse'
-require 'methadone'
+require 'gli'
 require 'gitignores'
-require 'gitignores/version'
-require 'gitignores/exceptions'
 
-class App
-  include Methadone::Main
-  include Methadone::CLILogging
-  include Methadone::ExitNow
+include GLI::App
 
-  main do |command, *ignores|
-    opts = {
-      :ignores_dir => options['use-directory'],
-      :update_ignores => options['update']
-    }
+program_desc Gitignores::SUMMARY
+version Gitignores::VERSION
+subcommand_option_handling :normal
+arguments :strict
+config_file '.gitignoresrc'
 
-    gitignores = Gitignores::Gitignores.new(options)
+desc 'the directory in which to store the gitlab/gitignore repository'
+default_value ENV['HOME']  + '/.gitignores'
+flag ['local-repository'], :desc => 'path to the local github/gitignore repository',
+                           :arg_name => 'path'
 
-    if(options[:os])
-      ignores.concat ["OSX", "Windows", "Linux"]
-    end
-    ignores.uniq!
-
-    begin
-      case command
-      when "add"
-        gitignores.add(ignores)
-      when "show"
-        gitignores.show(ignores)
-      when "list"
-        gitignores.list
-      when "update"
-        gitignores.update
-      else
-        help_now! "Command \"#{command}\" not recognized. Valid commands are 'add' 'show' 'list' 'update'"
-      end
-    rescue Gitignores::GitignoreNotFoundException => e
-      exit_now(1, "Couldn't find ignore \"#{e.ignore_name}\"")
+desc 'the remote github/gitignores repository'
+long_desc %q(
+change the remote github/gitignores repository to use a fork or an intranet 
+repository behind the firewall
+)
+default_value 'https://github.com/github/gitignore.git'
+flag ['remote-repository'], :desc => 'URL for the remote github/gitignore repository',
+                            :arg_name => 'url'
+
+
+desc 'appends a new gitignore snippet to the .gitignore in the current working directory'
+long_desc %q(
+Appends one or more snippets to the .gitignore file in the current working directory. 
+Each snippet name is space separated e.g. "Java JetBrains". 
+Use the list command to show possible values for snippet names.
+)
+arg 'snippet', :multiple
+command :add do |c|
+  c.desc 'include snippets for operating systems OSX, Windows, Linux'
+  c.switch :os, :negatable => false
+  c.action do |global_options,options,args|
+    if (options[:os])
+      args.concat ['OSX', 'Windows', 'Linux']
     end
+    args.uniq!
+    $gitignores.add(args)
+  end
+end
+
+
+desc 'lists gitignore snippet names'
+command :list do |c|
+  c.action do |global_options,options,args|
+    $gitignores.list
+  end
+end
+
+
+desc 'dumps the given snippet(s) to standard out'
+long_desc %q(
+Dumps one or more snippets to standard out.
+Each snippet name is space separated e.g. "Java JetBrains". 
+Use the list command to show possible values for snippet names.
+)
+arg 'snippet', :multiple
+command :show do |c|
+  c.action do |global_options,options,args|
+    $gitignores.show(args)
   end
+end
 
-  options['use-directory'] = ENV['HOME'] + '/.gitignores'
-  on("-d ignore-repository", "--use-directory", "The directory in which to store the github/gitignore directory")
-  on("--update", "Update the github/gitignore repository")
-  on("--os", "Include ignores for all operating systems")
 
-  arg :command, :required, "One of add, show, list, update. add = appends a new gitignore to the .gitignore in current working directory. list = lists gitignore snippet names. show = dumps the given gitignore(s) to std_out. update = pull the latest from github/gitignore"
-  arg :ignores, :any, "space-separated list of gitignore snippets. use the `list` command to see valid names (case sensitive)"
+desc 'pulls the latest from github/gitignore'
+long_desc %q(
+Pulls the latest version of github/gitignore to update the local repository of snippets 
+)
+command :update do |c|
+  c.action do |global_options,options,args|
+    $gitignores.update
+  end
+end
 
-  description Gitignores::DESCRIPTION
 
-  version Gitignores::VERSION
+pre do |global,command,options,args|
+  opts = {
+    :local_repository => global['local-repository'],
+    :remote_repository => global['remote-repository']
+  }
+  $gitignores = Gitignores::Gitignores.new(opts)
+  true
+end
 
-  use_log_level_option
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
 
-  go!
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
 end
+
+exit run(ARGV)

data/gitignores.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','gitignores','version.rb'])
+Gem::Specification.new do |gem| 
+  gem.name = 'gitignores'
+  gem.version = Gitignores::VERSION
+  gem.author = 'Johnathan Gilday'
+  gem.email = 'me@johnathangilday.com'
+  gem.platform = Gem::Platform::RUBY
+  gem.summary = Gitignores::SUMMARY
+  gem.homepage = 'https://github.com/gilday/gitignore-builder'
+  
+  gem.files = `git ls-files`.split("
+")
+  gem.require_paths << 'lib'
+  gem.has_rdoc = true
+  gem.bindir = 'bin'
+  gem.executables << 'gitignores'
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rdoc')
+  gem.add_development_dependency('rspec')
+  gem.add_runtime_dependency('gli','2.13.3')
+end
+

data/lib/gitignores.rb

@@ -1,22 +1,20 @@
-require 'logger'
-require 'methadone'
 require 'gitignores/builder'
+require 'gitignores/exceptions'
 require 'gitignores/fetcher'
+require 'gitignores/version'
+
 
 module Gitignores
   class Gitignores
-    include Methadone::CLILogging
 
     def initialize(options = {})
       options = {
-        :update_ignores => false,
-        :ignores_dir => ENV['HOME'] + '/.gitignores'
+        :local_repository => ENV['HOME'] + '/.gitignores'
       }.merge(options)
 
       @builder = GitignoreBuilder.new
-      @builder.ignores_dir = options[:ignores_dir]
-      @fetcher = GitignoreFetcher.new(options[:ignores_dir])
-      @fetcher.update_ignores = options[:update_ignores]
+      @builder.local_repository = options[:local_repository]
+      @fetcher = GitignoreFetcher.new(options[:local_repository], options[:remote_repository])
 
       @fetcher.fetch_gitignores
     end
@@ -32,7 +30,7 @@ module Gitignores
 
     def list()
       @fetcher.list_gitignores.each { |x|
-        info(x)
+        puts x
       }
     end
 

data/lib/gitignores/builder.rb

@@ -1,14 +1,12 @@
 require 'gitignores/exceptions'
-require 'methadone'
 
 module Gitignores
   class GitignoreBuilder
-    include Methadone::CLILogging
 
-    attr_writer :ignores_dir
+    attr_writer :local_repository
 
     def initialize
-      @ignores_dir = ENV['HOME'] + '/.gitignores'
+      @local_repository = ENV['HOME'] + '/.gitignores'
     end
 
     def build(ignores, out)
@@ -17,11 +15,10 @@ module Gitignores
 
     def find_gitignores_by_name(ignores) 
       ignores.collect { |x| 
-        path = File.exists?("#{@ignores_dir}/#{x}.gitignore") ? "#{@ignores_dir}/#{x}.gitignore" : "#{@ignores_dir}/Global/#{x}.gitignore"
+        path = File.exists?("#{@local_repository}/#{x}.gitignore") ? "#{@local_repository}/#{x}.gitignore" : "#{@local_repository}/Global/#{x}.gitignore"
         unless File.exists? path
           raise GitignoreNotFoundException.new(x), "File #{path} does not exist"
         end
-        debug "Found file #{path}"
         File.expand_path(path)
       }
     end
@@ -37,4 +34,4 @@ module Gitignores
       }
     end
   end
-end
+end

data/lib/gitignores/fetcher.rb

@@ -1,36 +1,33 @@
-require 'methadone'
 require 'gitignores'
 
 module Gitignores
   class GitignoreFetcher
-    include Methadone::CLILogging
 
-    attr_writer :git, :update_ignores, :ignores_dir
+    attr_writer :git, :update_ignores, :local_repository, :remote_repository
 
-    def initialize(ignores_dir)
-      @ignores_dir = ignores_dir
+    def initialize(local_repository, remote_repository)
+      @local_repository = local_repository
+      @remote_repository = remote_repository
       @update_ignores = false
       @git = Git.new
     end
 
-    # If needed, retrieves gitignores from Github and places them in @ignores_dir
+    # If needed, retrieves gitignores from Github and places them in @local_repository
     # If @update_ignores? is set, will try to update the latest gitignores
-    # Will store all gitignores in the @ignores_dir
+    # Will store all gitignores in the @local_repository
     def fetch_gitignores()
-      unless (Dir.exists?(@ignores_dir))
-        debug "Cloning github/gitignores to #{@ignores_dir}"
-        @git.clone 'https://github.com/github/gitignore.git', @ignores_dir
+      unless (Dir.exists?(@local_repository))
+        @git.clone @remote_repository, @local_repository
       end
       if @update_ignores
-        debug "Updating repository at #{@ignores_dir}"
-        @git.pull @ignores_dir
+        @git.pull @local_repository
       end
     end
 
     def list_gitignores()
       fetch_gitignores
 
-      Dir.glob(@ignores_dir + "/**/*.gitignore").collect { |x| 
+      Dir.glob(@local_repository + "/**/*.gitignore").collect { |x| 
         File.basename x, ".gitignore"
       }
     end
@@ -38,17 +35,15 @@ module Gitignores
 
   # Encapsulate Git commands in this helper class in order to help mock the command line
   class Git
-    include Methadone::SH
-    include Methadone::CLILogging
 
-    def clone(repo, directory)
-      sh! "git clone #{repo} #{directory}"
+    def clone(repository, directory)
+       `git clone #{repository} #{directory}`
     end
 
     def pull(directory) 
       Dir.chdir(directory) {
-        sh! "git pull"
+        `git pull`
       }
     end
   end
-end
+end

data/lib/gitignores/version.rb

@@ -1,5 +1,5 @@
 module Gitignores
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 
   SUMMARY = "Generates .gitignore"
 

data/spec/fake_ignores/Global/bar.gitignore

@@ -0,0 +1 @@
+bar

data/spec/fake_ignores/foo.gitignore

@@ -0,0 +1 @@
+foo

data/spec/gitignore_builder_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'fileutils'
+include Gitignores
+
+describe GitignoreBuilder do
+
+  before :each do
+    @builder = GitignoreBuilder.new
+  end
+
+  # Really simple test because I'm a Ruby newb
+  describe "#new" do
+    it "creates a new GitignoreBuilder" do
+      @builder.should be_an_instance_of GitignoreBuilder
+    end
+  end
+
+  describe "#find_gitignores_by_name" do
+    it "finds corresponding file paths for gitignores by name" do
+      @builder.local_repository = FAKE_IGNORES
+      paths = @builder.find_gitignores_by_name ["foo", "bar"]
+
+      fake_ignores_root = File.expand_path(FAKE_IGNORES)
+      paths.should include("#{fake_ignores_root}/foo.gitignore")
+      paths.should include("#{fake_ignores_root}/Global/bar.gitignore")
+    end
+
+    it "raises GitignoreNotFound exception if it cannot find a Gitignore" do
+      @builder.local_repository = FAKE_IGNORES
+      expect { @builder.find_gitignores_by_name ["baz"] }.to raise_error(GitignoreNotFoundException)
+    end
+  end
+
+  describe "#concatenate_files" do
+
+    it "concatenates files to a stream and provides a header before each one" do
+      out = StringIO.new
+      @builder.concatenate_files(["#{FAKE_IGNORES}/foo.gitignore", "#{FAKE_IGNORES}/Global/bar.gitignore"], out)
+
+      out.string.should eq(
+"
+\# foo
+
+foo
+
+\# bar
+
+bar
+"
+      )
+    end
+  end
+end

data/spec/gitignore_fetcher_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+include Gitignores
+
+describe Git do
+  before :each do
+    @git = Git.new
+  end
+
+  it "downloads the repository to the given directory" do
+    test_repository = 'tmp/test-repo'
+    FileUtils.rm_rf(test_repository)
+    @git.clone '.', test_repository
+
+    File.exists?(test_repository).should be_true
+    Dir[test_repository].empty?.should be_false
+  end
+end
+
+describe GitignoreFetcher do
+
+  before :each do
+    @fetcher = GitignoreFetcher.new(LOCAL_REPO, REMOTE_REPO)
+    @mockGit = double('Git')
+    @fetcher.git = @mockGit
+  end
+
+  describe "#fetch_gitignores" do
+
+    it "downloads the github/gitignore repository" do 
+      @mockGit.should_receive(:clone)
+
+      @fetcher.fetch_gitignores
+    end     
+
+    it "updates the repository when given update flag" do
+      @fetcher.update_ignores = true
+      @mockGit.stub(:clone)
+      @mockGit.should_receive(:pull).with(anything())
+
+      @fetcher.fetch_gitignores
+    end
+  end
+
+  describe "#list_gitignores" do
+
+    it "finds all gitignores in the directory and returns their names in a list" do
+      @mockGit.stub(:clone)
+      @fetcher.local_repository = FAKE_IGNORES
+      ignores = @fetcher.list_gitignores
+
+      ignores.should include("foo", "bar")
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require_relative '../lib/gitignores'
+require_relative '../lib/gitignores/fetcher'
+require_relative '../lib/gitignores/builder'
+require_relative '../lib/gitignores/exceptions'
+
+LOCAL_REPO = 'tmp/gitignores'
+REMOTE_REPO = 'bogus'
+FAKE_IGNORES = 'spec/fake_ignores'

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: gitignores
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Johnathan Gilday
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-25 00:00:00.000000000 Z
+date: 2015-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -25,63 +25,74 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: methadone
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 2.13.3
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-description: Tool for building .gitignore from community templates at github/gitignore
-email:
-- me@johnathangilday.com
+        version: 2.13.3
+description: 
+email: me@johnathangilday.com
 executables:
 - gitignores
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
+- README.rdoc
+- Rakefile
 - bin/gitignores
+- gitignores.gemspec
 - lib/gitignores.rb
 - lib/gitignores/builder.rb
 - lib/gitignores/exceptions.rb
 - lib/gitignores/fetcher.rb
 - lib/gitignores/version.rb
+- spec/fake_ignores/Global/bar.gitignore
+- spec/fake_ignores/foo.gitignore
+- spec/gitignore_builder_spec.rb
+- spec/gitignore_fetcher_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/gilday/gitignore-builder
 licenses: []
 metadata: {}
@@ -89,6 +100,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='