sourcerer_ 0.0.2.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d96577345c38942604430d4c8b59378bc098391e
+  data.tar.gz: fcc9390a4737f5a1d23ffdcf9ee96907452a79a9
+SHA512:
+  metadata.gz: dc02b2c2da733a0520d13a552f2b4bf63f8f89bcbb688355a94b61863083e1d0834a8a598e958f10f9c7be84baa8cb681cdd917d8289d47b127e73dac3e41452
+  data.tar.gz: 3ae263f9175e8c605a390723b513bb07c4dbfde172d5675a2d449dfd41e55f2e576ffdfe94bb7fcd95ec5fb8aa46c007fccb5f8a940a519aa3305af8df2e4929

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+###### 0.0.2.pre
+###### 0.0.1.pre
+* MVP

data/README.md

@@ -0,0 +1,64 @@
+[![gem version](https://badge.fury.io/rb/sourcerer_.svg)](https://rubygems.org/gems/sourcerer_)
+[![dependencies](https://gemnasium.com/brewster1134/sourcerer.svg)](https://gemnasium.com/brewster1134/sourcerer)
+[![docs](http://inch-ci.org/github/brewster1134/sourcerer.svg?branch=master)](http://inch-ci.org/github/brewster1134/sourcerer)
+[![build](https://travis-ci.org/brewster1134/sourcerer.svg?branch=master)](https://travis-ci.org/brewster1134/sourcerer)
+[![coverage](https://coveralls.io/repos/brewster1134/sourcerer/badge.svg?branch=master)](https://coveralls.io/r/brewster1134/sourcerer?branch=master)
+[![code climate](https://codeclimate.com/github/brewster1134/sourcerer/badges/gpa.svg)](https://codeclimate.com/github/brewster1134/sourcerer)
+
+# SOURCERER
+###### Consume local & remote sources with ease
+---
+
+From inside a ruby app, you can quickly grab entire directories of assets, either locally from a zip file or folder, or remotely from a git repo or zip file.
+
+---
+#### Install
+```shell
+gem install sourcerer_
+```
+
+---
+#### Quick Usage
+```ruby
+require 'sourcerer'
+
+# download a remote github repo to your Documents folder
+source = Sourcerer.new 'brewster1134/sourcerer', '~/Documents/sourcerer'
+
+# use file globbing to return a custom array of files
+source.files '**/*_helper.rb'
+=> ["spec/spec_helper.rb"]
+```
+
+---
+#### Supported Sources
+* git repo
+  * local or remote
+  * github shorthand _(see example)_
+* zip files
+  * local or remote
+* local directories _(although not very useful)_
+  * relative or absolute paths
+
+---
+#### Roadmap
+* Command line tool
+* Automate consuming multiple sources with a sourcerer.yaml file
+* Support for branches, tags & commits from a git repo
+
+---
+#### Development
+###### Install Dependencies
+```shell
+# clone repo
+git clone https://github.com/brewster1134/sourcerer.git
+cd sourcerer
+
+# install dependencies
+bundle install
+
+# run watcher for linting and tests
+bundle exec guard
+```
+
+[![WTFPL](http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl-badge-4.png)](http://www.wtfpl.net)

data/i18n/en.yml

@@ -0,0 +1,15 @@
+en: &en
+  sourcerer:
+    errors:
+      core:
+        get_type_source:
+          no_type_detected: No supported type could be determined from `%{source}`. Make sure the source is in a supported format.
+      source_type:
+        initialize:
+          destination_already_exists: The directory %{destination} already exists. Choose a new destination to be created.
+
+# regional variations
+en_gb:
+  <<: *en
+en_us:
+  <<: *en

data/lib/sourcerer/core.rb

@@ -0,0 +1,100 @@
+#
+# Sourcerer::Core
+# Base class for initializing Sourcerer
+#
+class Sourcerer::Core
+  GIT_GITHUB_SHORTHAND_REGEX = %r{^[A-Za-z0-9-]+\/[A-Za-z0-9\-_.]+$}
+  attr_reader :source_type
+
+  # Initialize a new sourcerer core object
+  # @param source       [String]  A valid source location or supported shorthand
+  # @param destination  [String]  A local path to copy the source to, nil
+  # @return [Sourcerer::SourceType[TYPE]]
+  #
+  def initialize source, destination, options
+    # get absolute path of destination
+    destination = File.expand_path(destination)
+
+    # initialize a source type object
+    type_source = options[:type] || get_type_source(source)
+    type = type_source[:type]
+    source = type_source[:source]
+    type_class = get_type_class type
+    @source_type = type_class.new source, destination, options
+  end
+
+  # Determine the type of source based on a string
+  # @param  source  [String]  A string representing a local or remote source location
+  # @return [Hash]  An object with a supported source :type and :source
+  # @raise [Sourcerer::Error] Could not determine the source type based on the provided source
+  # @todo Add additional source types
+  #
+  # rubocop:disable Metrics/CyclomaticComplexity
+  def get_type_source source
+    type_source = nil
+
+    # LOCAL
+    #
+    # => local directory
+    expanded_source = File.expand_path(source)
+    if Dir.exist?(expanded_source)
+      type_source = {
+        type: :dir,
+        source: expanded_source
+      }
+
+    # => local file
+    elsif File.exist?(expanded_source)
+      case File.extname(expanded_source)
+
+      # => local zip file
+      when '.zip'
+        type_source = {
+          type: :zip,
+          source: expanded_source
+        }
+      end
+
+    # REMOTE
+    #
+    # => remote file
+    else
+      case File.extname(source)
+
+      # => remote zip file
+      when '.zip'
+        type_source = {
+          type: :zip,
+          source: source
+        }
+
+      # => remote git repo
+      when '.git', ''
+        type_source = {
+          type: :git,
+          source: source
+        }
+      end
+    end
+
+    return type_source unless type_source.nil?
+
+    # raise an error if no source type was found
+    raise Sourcerer::Error.new 'core.get_type_source.no_type_detected', source: source
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+
+  # Initialize a new source type from the provided symbol
+  # @param  type  [Symbol]  A supported source type name
+  # @return [Sourcerer::SourceType::[TYPE]]
+  #
+  def get_type_class type
+    "Sourcerer::SourceType::#{type.to_s.classify}".constantize
+  end
+
+  # @see Sourcerer::SourceType#files
+  #
+  def files *args
+    source_type.files *args
+  end
+end

data/lib/sourcerer/error.rb

@@ -0,0 +1,13 @@
+#
+# Sourcerer::Error
+# Custom error class
+#
+class Sourcerer::Error < StandardError
+  # @param i18n_keys      [String]  Dot delimited heirarchy of i18n key
+  # @param i18n_args_hash [Hash]    Object of values to pass to i18n
+  # @return [Sourcerer::Error]
+  #
+  def initialize i18n_keys, i18n_args_hash
+    I18n.t "sourcerer.errors.#{i18n_keys}", i18n_args_hash
+  end
+end

data/lib/sourcerer/metadata.rb

@@ -0,0 +1,4 @@
+module Sourcerer
+  VERSION = '0.0.2.pre'.freeze
+  SUMMARY = 'Consume local & remote sources with ease'.freeze
+end

data/lib/sourcerer/source_type.rb

@@ -0,0 +1,45 @@
+#
+# Sourcerer::SourceType
+# Base class for supported source types
+#
+class Sourcerer::SourceType
+  def initialize source, destination, options
+    @destination = destination
+
+    # raise error if destination already exists
+    if ::Dir.exist? @destination
+      raise Sourcerer::Error.new 'source_type.initialize.destination_already_exists', destination: @destination
+    end
+
+    # calls the custom `move` method for the given type
+    move source, destination, options
+
+    self
+  end
+
+  # Return an array of file paths that match the provided glob
+  #
+  def files glob = :all, relative = false
+    glob = case glob
+    when :all
+      '**/*'
+    when :hidden
+      '**/.*'
+    else
+      glob
+    end
+
+    files = ::Dir.glob(File.join(@destination, glob), File::FNM_DOTMATCH).select do |file|
+      File.file? file
+    end
+
+    if relative
+      base_path = Pathname.new @destination
+      files = files.collect do |file|
+        Pathname.new(file).relative_path_from(base_path).to_s
+      end
+    end
+
+    files
+  end
+end

data/lib/sourcerer/source_types/dir.rb

@@ -0,0 +1,9 @@
+#
+# Sourcerer::SourceTypeDir
+# Handler for directory sources
+#
+class Sourcerer::SourceType::Dir < Sourcerer::SourceType
+  def move source, destination, _options
+    FileUtils.cp_r "#{source}/.", destination
+  end
+end

data/lib/sourcerer/source_types/git.rb

@@ -0,0 +1,21 @@
+#
+# Sourcerer::SourceTypeDir
+# Handler for git repo sources
+#
+class Sourcerer::SourceType::Git < Sourcerer::SourceType
+  require 'git'
+
+  def move source, destination, _options
+    # if git repo is remote
+    unless ::Dir.exist? source
+      # regex to match any repo url to only the usename and repo name
+      # @example
+      #   'https://github.com/brewster1134/sourcerer.git' #=> 'brewster1134/sourcerer'
+      regex = %r{^(?:.*com[:\/])?([^.]+)(?:\.git)?$}
+      username_repo = source.match(regex)[1]
+      source = "https://github.com/#{username_repo}.git"
+    end
+
+    ::Git.clone source, destination
+  end
+end

data/lib/sourcerer/source_types/zip.rb

@@ -0,0 +1,16 @@
+#
+# Sourcerer::SourceTypeDir
+# Handler for zip file sources
+#
+class Sourcerer::SourceType::Zip < Sourcerer::SourceType
+  require 'zip'
+
+  def move source, destination, _options
+    ::Zip::File.open(source) do |zip_file|
+      zip_file.each do |file|
+        file_path = File.join destination, file.name
+        zip_file.extract(file, file_path) unless File.exist? file_path
+      end
+    end
+  end
+end

data/lib/sourcerer.rb

@@ -0,0 +1,29 @@
+require 'active_support/core_ext/string/inflections'
+require 'i18n'
+require 'tmpdir'
+
+# I18n
+I18n.load_path += Dir[File.expand_path(File.join('i18n', '*.yml'))]
+I18n.locale = ENV['LANG'].split('.').first.downcase
+I18n.reload!
+
+#
+# Sourcerer
+# Entrypoint & controller
+#
+module Sourcerer
+  def self.new source, destination, options = {}
+    Sourcerer::Core.new source, destination, options
+  end
+end
+
+# SOURCERER LIBRARY
+require 'sourcerer/core'
+require 'sourcerer/error'
+require 'sourcerer/metadata'
+require 'sourcerer/source_type'
+
+# Requre all source types
+Dir[File.join(Dir.pwd, 'lib', 'sourcerer', 'source_types', '*.rb')].each do |file|
+  require file
+end

data/lib/sourcerer_.rb

@@ -0,0 +1,2 @@
+# file to require that matches the actual gem name
+require 'sourcerer'

data/spec/fixtures/i18n.yml

@@ -0,0 +1,5 @@
+spec:
+  sourcerer:
+    errors:
+      foo:
+        bar: This %{foo} is a %{bar}

data/spec/fixtures/source.git/COMMIT_EDITMSG

@@ -0,0 +1 @@
+source.git

data/spec/fixtures/source.git/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

data/spec/fixtures/source.git/config

@@ -0,0 +1,7 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true
+	ignorecase = true
+	precomposeunicode = true

data/spec/fixtures/source.git/description

@@ -0,0 +1 @@
+Unnamed repository; edit this file 'description' to name the repository.

data/spec/fixtures/source.git/hooks/applypatch-msg.sample

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message taken by
+# applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.  The hook is
+# allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "applypatch-msg".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/commit-msg" &&
+	exec "$GIT_DIR/hooks/commit-msg" ${1+"$@"}
+:

data/spec/fixtures/source.git/hooks/commit-msg.sample

@@ -0,0 +1,24 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by "git commit" with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}

data/spec/fixtures/source.git/hooks/post-update.sample

@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# An example hook script to prepare a packed repository for use over
+# dumb transports.
+#
+# To enable this hook, rename this file to "post-update".
+
+exec git update-server-info

data/spec/fixtures/source.git/hooks/pre-applypatch.sample

@@ -0,0 +1,14 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed
+# by applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-applypatch".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/pre-commit" &&
+	exec "$GIT_DIR/hooks/pre-commit" ${1+"$@"}
+:

data/spec/fixtures/source.git/hooks/pre-commit.sample

@@ -0,0 +1,49 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed.
+# Called by "git commit" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message if
+# it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-commit".
+
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
+fi
+
+# If you want to allow non-ASCII filenames set this variable to true.
+allownonascii=$(git config --bool hooks.allownonascii)
+
+# Redirect output to stderr.
+exec 1>&2
+
+# Cross platform projects tend to avoid non-ASCII filenames; prevent
+# them from being added to the repository. We exploit the fact that the
+# printable range starts at the space character and ends with tilde.
+if [ "$allownonascii" != "true" ] &&
+	# Note that the use of brackets around a tr range is ok here, (it's
+	# even required, for portability to Solaris 10's /usr/bin/tr), since
+	# the square bracket bytes happen to fall in the designated range.
+	test $(git diff --cached --name-only --diff-filter=A -z $against |
+	  LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
+then
+	cat <<\EOF
+Error: Attempt to add a non-ASCII file name.
+
+This can cause problems if you want to work with people on other platforms.
+
+To be portable it is advisable to rename the file.
+
+If you know what you are doing you can disable this check using:
+
+  git config hooks.allownonascii true
+EOF
+	exit 1
+fi
+
+# If there are whitespace errors, print the offending file names and fail.
+exec git diff-index --check --cached $against --

data/spec/fixtures/source.git/hooks/pre-push.sample

@@ -0,0 +1,54 @@
+#!/bin/sh
+
+# An example hook script to verify what is about to be pushed.  Called by "git
+# push" after it has checked the remote status, but before anything has been
+# pushed.  If this script exits with a non-zero status nothing will be pushed.
+#
+# This hook is called with the following parameters:
+#
+# $1 -- Name of the remote to which the push is being done
+# $2 -- URL to which the push is being done
+#
+# If pushing without using a named remote those arguments will be equal.
+#
+# Information about the commits which are being pushed is supplied as lines to
+# the standard input in the form:
+#
+#   <local ref> <local sha1> <remote ref> <remote sha1>
+#
+# This sample shows how to prevent push of commits where the log message starts
+# with "WIP" (work in progress).
+
+remote="$1"
+url="$2"
+
+z40=0000000000000000000000000000000000000000
+
+IFS=' '
+while read local_ref local_sha remote_ref remote_sha
+do
+	if [ "$local_sha" = $z40 ]
+	then
+		# Handle delete
+		:
+	else
+		if [ "$remote_sha" = $z40 ]
+		then
+			# New branch, examine all commits
+			range="$local_sha"
+		else
+			# Update to existing branch, examine new commits
+			range="$remote_sha..$local_sha"
+		fi
+
+		# Check for WIP commit
+		commit=`git rev-list -n 1 --grep '^WIP' "$range"`
+		if [ -n "$commit" ]
+		then
+			echo "Found WIP commit in $local_ref, not pushing"
+			exit 1
+		fi
+	fi
+done
+
+exit 0