sj_ignore 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bdfbff1b6214d0d84e372c5b4c995abc65c31f15
+  data.tar.gz: 945b2a72bf68be2edde2ca5e4dcbb750c3a4063b
+SHA512:
+  metadata.gz: 310236b2f6a7a27f8b3e6b75ed4f5700cad94692f40e4e14548fc155d6641091cc3594bfc4bf4b66e63bff122dfdf1d6ab140794480fcb1b9b635ad513f379e8
+  data.tar.gz: ccdd8a8c32b8670d7eb977cc8ab548d88f1c9e740559e19608cbab32e41b363c6d310174fe0c6c61da54be334a7a4e415e8c430c84389118577b3684428f5f15

data/.gitignore

@@ -0,0 +1,74 @@
+################################################################################
+# Ruby.gitignore
+################################################################################
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## 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
+
+################################################################################
+# Vim.gitignore
+################################################################################
+
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~
+
+################################################################################
+# OSX.gitignore
+################################################################################
+
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sj_ignore.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 sjdev
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,17 @@
+# sj-ignore
+
+This small utility makes generating a .gitignore file for a new project as
+painless as possible when dealing with multiple platforms or languages that you
+require .gitignore info for.
+
+## Example
+
+    sj-ignore ruby vim osx > .gitignore
+
+## TODO
+
+Pull `github/gitignore` repository so there is a local copy on the machine in
+order to speed up setup time and to avert the issue with github api rate
+limiting.
+
+Give option to define your own github repository of .gitignore files.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/sj_ignore

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'sj_ignore'
+
+# Define basic command line options
+help = false
+list = false
+api = false
+langs = []
+
+# Return a directory with the project libraries.
+def gem_libdir
+  t = ["#{File.dirname(File.expand_path($0))}/../lib/#{Meta::NAME}",
+        "#{Gem.dir}/gems/#{Meta::NAME}-#{Meta::VERSION}/lib/#{Meta::NAME}"]
+  t.each {|i| return i if File.readable?(i) }
+  raise "both paths are invalid: #{t}"
+end
+
+# Sort command line options, this is really stupid logic right now but it does
+# exactly what I need it to
+ARGV.each do |arg|
+  case arg
+  when '-h', '--help'
+    help = true
+  when '-l', '--list'
+    list = true
+  when '-a', '--api'
+    api = true
+  else
+    langs << arg
+  end
+end
+
+if help
+  print "Usage: ignore [--help] [--sync] [--list] [LANGUAGES]\n"
+  print "    --sync: Updates list of available .gitignore files\n"
+  print "    --list: Lists available\n"
+
+  exit
+end
+
+if not list and not api and langs.length == 0
+  STDERR.puts "No options passed into program"
+
+  exit
+end
+
+builder = SjIgnore::Builder.new api
+
+if list
+  builder.list
+end
+
+if langs
+  print builder.download_files langs
+end

data/lib/meta.rb

@@ -0,0 +1,6 @@
+module SjIgnore
+  module Meta
+    NAME = 'sj_ignore'
+    VERSION = '0.0.1'
+  end
+end

data/lib/sj-ignore.rb

@@ -0,0 +1,81 @@
+require 'github_api'
+require 'open-uri'
+
+module SJIgnore
+  class Builder
+    def initialize(list, langs)
+      contents = gh_load
+
+      # Print out a list of all available .gitignore files
+      if list
+        contents.each do |path, ref|
+          p path
+        end
+      end
+
+      # Begin fetching each .gitignore file requested
+      if langs
+        ignores = []
+
+        # Fetch each file
+        langs.each do |name|
+          # Check if the requested language/platform is available in the list of
+          # known .gitignore files
+          if contents.include? name.downcase
+            ref = contents[name]
+
+            # Download the file
+            open(ref.download_url, 'rb') do |file|
+              content = file.read
+
+              # Append the separator header before adding it to the downloaded list
+              content = header(ref.path.split('/').last) + content
+
+              ignores << content
+            end
+          else
+            STDERR.puts "Cannot find a .gitignore file for: #{name}"
+          end
+        end
+
+        # Join all .gitignore files together and print them to console
+        print ignores.join "\n"
+      end
+    end
+
+    def gh_load
+      # Create an interface with github's repo of gitignore files and pull a list of
+      # all of them
+      github = Github.new
+      contents_top = github.repos.contents.get user: 'github', repo: 'gitignore', path: '/'
+      contents_global = github.repos.contents.get user: 'github', repo: 'gitignore', path: '/Global'
+      contents = {}
+
+      # Filter out all non-gitignore files and add them to a lookup map
+      content_filter = Proc.new do |ref|
+        if ref.path.include? '.gitignore'
+          # Remove any possible path components and grab only the platform or
+          # language part of the file name, which will be used later
+          name = ref.path.split('/').last.split('.').first.downcase
+
+          contents[name] = ref
+        end
+      end
+
+      # Combine the two different directories of .gitignore files
+      contents_top.each(&content_filter)
+      contents_global.each(&content_filter)
+
+      contents
+    end
+
+    # This just generates a custom header used to separate the different
+    # .gitignore files once they are merged
+    def header(lang)
+      head =  "#" * 80    + "\n"
+      head += "# #{lang}" + "\n"
+      head += "#" * 80    + "\n"
+      head += "\n"
+    end
+  end
+end

data/lib/sj_ignore/version.rb

@@ -0,0 +1,3 @@
+module SjIgnore
+  VERSION = "0.0.1"
+end

data/lib/sj_ignore.rb

@@ -0,0 +1,131 @@
+require 'github_api'
+require 'open-uri'
+require 'pathname'
+
+require_relative 'utils'
+
+module SjIgnore
+  class Builder
+    def initialize(use_api)
+      if use_api
+        @contents = gh_load_remote
+      else
+        @contents = gh_load_local
+      end
+    end
+
+    def download_files(langs)
+      # Begin fetching each .gitignore file requested
+      ignores = []
+
+      # Fetch each file
+      langs.each do |name|
+        # Check if the requested language/platform is available in the list of
+        # known .gitignore files
+        if @contents.include? name.downcase
+          ref = @contents[name]
+
+          # Download the file
+          open(ref.file_path, 'rb') do |file|
+            content = file.read
+
+            # Append the separator header before adding it to the downloaded list
+            content = header(ref.name) + content
+
+            ignores << content
+          end
+        else
+          STDERR.puts "Cannot find a .gitignore file for: #{name}"
+        end
+      end
+
+      # Join all .gitignore files together and print them to console
+      return ignores.join "\n"
+    end
+
+    def list
+      # Print out a list of all available .gitignore files
+      @contents.each do |path, ref|
+        p path
+      end
+    end
+
+    private
+
+    def gh_load_local
+      git_repo = 'https://github.com/github/gitignore.git'
+      lib_dir = Pathname.new SjIgnore::Utils.gem_libdir
+      gitignore_dir = lib_dir + 'gitignore/'
+
+      if gitignore_dir.directory?
+        `cd \"#{gitignore_dir}\"
+         git pull`
+      else
+        `cd \"#{lib_dir}\"
+         git clone \"#{git_repo}\"`
+      end
+
+      local_files = Dir[gitignore_dir + "*.gitignore"]
+      global_files = Dir[gitignore_dir + "Global/*.gitignore"]
+
+      contents = {}
+
+      content_filter = Proc.new do |file|
+        if file.include? '.gitignore'
+          name = file.split('/').last.split('.').first.downcase
+          contents[name] = IgnoreFile.new(file.split('/').last, file)
+        end
+      end
+
+      local_files.each(&content_filter)
+      global_files.each(&content_filter)
+
+      contents
+    end
+
+    def gh_load_remote
+      # Create an interface with github's repo of gitignore files and pull a list of
+      # all of them
+      github = Github.new
+      contents_top = github.repos.contents.get user: 'github', repo: 'gitignore', path: '/'
+      contents_global = github.repos.contents.get user: 'github', repo: 'gitignore', path: '/Global'
+      contents = {}
+
+      # Filter out all non-gitignore files and add them to a lookup map
+      content_filter = Proc.new do |ref|
+        if ref.path.include? '.gitignore'
+          # Remove any possible path components and grab only the platform or
+          # language part of the file name, which will be used later
+          name = ref.path.split('/').last.split('.').first.downcase
+
+          contents[name] = IgnoreFile.new(ref.path.split('/').last, ref.download_url)
+        end
+      end
+
+      # Combine the two different directories of .gitignore files
+      contents_top.each(&content_filter)
+      contents_global.each(&content_filter)
+
+      contents
+    end
+
+    # This just generates a custom header used to separate the different
+    # .gitignore files once they are merged
+    def header(lang)
+      head =  "#" * 80    + "\n"
+      head += "# #{lang}" + "\n"
+      head += "#" * 80    + "\n"
+      head += "\n"
+    end
+  end
+
+  class IgnoreFile
+    attr_accessor :name
+    attr_accessor :file_path
+
+    def initialize(name, file_path)
+      self.name = name
+      self.file_path = file_path
+    end
+  end
+end

data/lib/utils.rb

@@ -0,0 +1,14 @@
+require_relative 'meta'
+
+module SjIgnore
+  module Utils
+    def self.gem_libdir
+      t = ["#{File.dirname(File.expand_path($0))}/../lib/#{Meta::NAME}",
+           "#{Gem.dir}/gems/#{Meta::NAME}-#{Meta::VERSION}/lib/#{Meta::NAME}"]
+      t.each {|i| return i if File.readable?(i) }
+      raise "both paths are invalid: #{t}"
+    end
+
+    # [...]
+  end
+end

data/sj_ignore.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sj_ignore/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sj_ignore"
+  spec.version       = SjIgnore::VERSION
+  spec.authors       = ["sjdev"]
+  spec.email         = ["shane@gianel.li"]
+  spec.summary       = "Easy command line utility to create a multi-faceted .gitignore file"
+  spec.description   = "sj-ignore uses github's gitignore repository to make it easy to list all the languages and platforms you would like included in your .gitignore file"
+  spec.homepage      = "https://github.com/sjdev/sj-ignore"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = ['sj_ignore']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "github_api", "~> 0.12.2"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: sj_ignore
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- sjdev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: sj-ignore uses github's gitignore repository to make it easy to list
+  all the languages and platforms you would like included in your .gitignore file
+email:
+- shane@gianel.li
+executables:
+- sj_ignore
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sj_ignore
+- lib/meta.rb
+- lib/sj-ignore.rb
+- lib/sj_ignore.rb
+- lib/sj_ignore/version.rb
+- lib/utils.rb
+- sj_ignore.gemspec
+homepage: https://github.com/sjdev/sj-ignore
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Easy command line utility to create a multi-faceted .gitignore file
+test_files: []