gemspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6703d9a6209f017896a24cb5611385a3d2aac0a8
+  data.tar.gz: bddb090732e5bad00b9d407fb5b30aa3bb35d146
+SHA512:
+  metadata.gz: 623760ee54ff5b7ee941774bd862eee71dc0eb821bf7317b2f128bfebcc547c213171c996a6e3fadcaa853d2dcd09362e01f71ddccef325e0d92f436f05798f2
+  data.tar.gz: 266f6377fd0b7125e8f2816e48ef93443b92bd070790f5898317cd2d3d4a095fc2717299c6d0ef8a72d5af10eec83d2c559289b6b723e6fcc3eb984c780e7e21

data/.gitignore

@@ -0,0 +1,2 @@
+/pkg/
+/Gemfile.lock

data/Gemfile

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

data/LICENSES/.info

@@ -0,0 +1 @@
+This directory contains the licenses you can use with this gem

data/LICENSES/MIT

@@ -0,0 +1,9 @@
+
+MIT License
+Copyright (c) <year> <copyright holders>
+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.
+
+  There is no standard license header for the license
+  

data/README.md

@@ -0,0 +1,26 @@
+# Gemspec
+
+Gemspec is a convention-over-configuration library for creating gems.
+
+## Gemspec::boilerplate
+The main functionality of the libary is the `Gemspec::boilerplate` method, which when called with a `Gem::Specification`
+as its argument, adds standard boilerplate to your gemspec.
+
+It assumes you're using `Git`, and it infers most of the gemspec boilerplate from:
+
+1) the name\* of your gem, which defaults to the name of your project's directory
+2) your git data
+
+Additionally, it:
+
+1) `git init`s your project directory unless it's already been initialized
+2) scaffolds out the files and directories your `lib` folder should contain based on your project's name,
+  unless those files and directories already exist.
+
+\*The naming convetions it uses are those laid out in http://guides.rubygems.org/name-your-gem/.
+
+## Usage
+
+  gem install gemspec
+
+

data/VERSION

@@ -0,0 +1 @@
+lib/gemspec/VERSION

data/VERSIONING.md

@@ -0,0 +1,18 @@
+## Versioning
+### Version Number for Machines
+
+This gem uses a slightly modified version of the **SemVer** specification, namely:
+```ruby
+    spec.version = "BREAKING.PATCHES.NONBREAKING"
+```
+You can use this versioning with your dependency tools, only you have a somewhat stronger guarantee that your
+code won't break if you limit yourself to the third number, but you need to allow second level updates in order to
+get (security and other) patches.
+
+### Version Number for Humans
+Since the above-described type of versioning doesn't tell you anything about the functional state of the gem (you can go from a "hello world" to a full blown operating system
+without making a breaking change, as long as your operating system prints "hello world" to the screen) (SemVer, when used correctly, doesn't tell anything about the functional state of a software package either), a second, human-friendly version number can be found in `spec.metadata[:human_version]`.
+
+The magnitude of this version number shall be made to correspond to actual functional changes in the software. If I've worked a lot on the package, I'll make it move a lot, but unless I've made breaking changes, I'll stick to only moving the third number in the `spec.version` version.
+
+This number is for you. If you see it increase a lot, it probably means much more new goodies, but is less strictly defined then the version number for the machine.  (I reserve the right to later change the way I change this number).

data/VERSION_FOR_HUMANS

@@ -0,0 +1 @@
+lib/gemspec/VERSION_FOR_HUMANS

data/gemspec.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+#Naming utils, git utils, and default boilerplate
+require 'gemspec'
+
+#This is a place to put custom overrides to Gemspec.boilerplate
+begin; require_relative 'gemspec.rb'; rescue LoadError; end
+
+Gem::Specification.new do |s|
+
+  #Name is the name of the project root directory
+  s.name           = Gemspec.base_dirname(__FILE__)
+
+  Gemspec.boilerplate(s)
+
+  #s.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+
+  #####Must change
+  s.summary       = %q{Gemspec aims to streamline and DRY up the creation of ruby packages AKA gems}
+  s.description   = File.read('README.md')
+  s.licenses      = %w[MIT]
+
+
+  #####Unlikely to change
+  s.email         = [ `git config user.email` ]
+  s.homepage      = "https://github.com/#{`git config github.username`}/#{s.name}.git"
+  ###################################
+
+  s.add_dependency 'activesupport', '4.2.1'
+  s.add_dependency 'memoist', '0.12.0'
+  s.add_dependency 'rake', '~> 10.4'
+
+end

data/lib/gemspec.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+
+#Gemspec::boilerplate
+# - adds standard boilerplate to its argument (assumed to be a Gem::Specification) based on the spec's name and git-provided data
+# - if they don't exist, it scaffolds basic lib files which should exist for the spec name
+
+require 'gemspec/bootstrap_lib'
+require 'gemspec/camelize'
+require 'gemspec/base_dirname'
+require 'gemspec/git'
+
+module Gemspec
+  module_function
+
+  #####These settings shouldn't change as long as you follow conventions
+  def boilerplate(s)
+    Dir.exist?('.git') || system('git', 'init', '.')
+
+    #Naming according to conventions
+    s.metadata["namespaced_path"] = s.name.tr('-', '/')
+    s.metadata["constant_name"] = camelize(s.metadata["namespaced_path"])
+
+    #Add lib to path so that the version file can be loaded
+    lib = File.expand_path('lib')
+    $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+    #Bootstrap the lib directory along with the basic *.rb files
+    #This won't overwrite existing files
+    Gemspec::bootstrap_lib!(s)
+
+    #Get VERSION and VERSION_FOR_HUMANS from the version file
+    require "#{s.metadata["namespaced_path"]}/version"
+    spec_module         = Object.const_get(s.metadata["constant_name"])
+    s.version        = spec_module::VERSION
+    s.metadata["human_version"] = spec_module::VERSION_FOR_HUMANS
+
+    #Specify common paths and files
+    s.test_files    = Git::ls_files.grep(%r{^(test|s|features)/})
+    s.files         = Git::ls_files.reject { |f| f.match(%r{^(test|s|features)/}) }
+    s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+    s.require_paths = ["lib"]
+
+    #Authors are all committers or `git config user.name` if the former is empty
+    s.authors       = Git::ls_authors
+  end
+end

data/lib/gemspec/HUMAN_VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/gemspec/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/gemspec/VERSION_FOR_HUMANS

@@ -0,0 +1 @@
+0.1.0

data/lib/gemspec/base_dirname.rb

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+
+require 'pathname'
+module Gemspec
+  module_function
+  def base_dirname(file)
+    Pathname.new(file).dirname.realdirpath.basename.to_s
+  end
+end

data/lib/gemspec/bootstrap_lib.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'yaml'
+require 'erb'
+require 'fileutils'
+
+require 'memoist'
+
+require 'gemspec/camelize'
+
+module Gemspec
+  extend Memoist
+
+  module_function
+
+  def bootstrap_lib!(spec)
+
+    config = {}
+    config["constant_name"] = spec.metadata["constant_name"] || camelize(metadata["namespaced_path"])
+    config["namespaced_path"] = spec.metadata["namespaced_path"] || spec.name.tr('-', '/')
+    config["constant_array"] = config["constant_name"].split("::")
+
+    path = "lib/#{config["namespaced_path"]}"
+    versionfilerb = "#{path}/version.rb"
+    versionfile = "#{path}/VERSION"
+    human_versionfile = "#{path}/VERSION_FOR_HUMANS"
+    rbfile = "#{path}.rb"
+
+    FileUtils.mkdir_p path
+
+    template_write(rbfile, config, templates["newgem.tt"])  unless File.exist?(rbfile)
+    template_write(versionfilerb, config, templates["version.rb.tt"])  unless File.exist?(versionfilerb)
+    File.write(versionfile, '0.1.0') unless File.exist?(versionfile)
+    File.write(human_versionfile, '0.1.0') unless File.exist?(human_versionfile)
+  end
+
+  memoize def templates
+    ret = nil
+    File.open(__FILE__) do |this_file|
+      this_file.find { |line| line =~ /^__END__ *$/ }
+      ret = YAML.load(this_file.read)
+    end
+    return ret
+  end
+
+  def template_write(filename, config, template_str)
+    File.write(filename, ERB.new(template_str, nil,'-').result(binding))
+  end
+end
+
+__END__
+---
+newgem.tt: |
+  require "<%=config["namespaced_path"]%>/version"
+  <%- if config[:ext] -%>
+  require "<%=config["namespaced_path"]%>/<%=config["name"]%>"
+  <%- end -%>
+
+  <%- config["constant_array"].each_with_index do |c,i| -%>
+  <%= '  '*i %>module <%= c %>
+  <%- end -%>
+  <%= '  '*config["constant_array"].size %>
+  <%- (config["constant_array"].size-1).downto(0) do |i| -%>
+  <%= '  '*i %>end
+  <%- end -%>
+version.rb.tt: |
+  <%- config["constant_array"].each_with_index do |c,i| -%>
+  <%= '  '*i %>module <%= c %>
+  <%- end -%>
+  <%= '  '*config["constant_array"].size %>VERSION = File.read(File.expand_path("../VERSION", __FILE__))
+  <%= '  '*config["constant_array"].size %>VERSION_FOR_HUMANS = File.read(File.expand_path("../VERSION_FOR_HUMANS", __FILE__))
+  <%- (config["constant_array"].size-1).downto(0) do |i| -%>
+  <%= '  '*i %>end
+  <%- end -%>

data/lib/gemspec/camelize.rb

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+require 'forwardable'
+require 'active_support/inflector/methods'
+
+module Gemspec
+  module CamelizeMethod
+    extend Forwardable
+    def_delegators ::ActiveSupport::Inflector, :camelize
+  end
+  extend CamelizeMethod
+end
+

data/lib/gemspec/git.rb

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+
+require 'memoist'
+require 'super_hash'
+
+    Dir.exist?('.git') || system(*%w[git init .])
+module Gemspec
+  module Git
+    extend Memoist
+    module_function
+
+    memoize def ls_files
+      `git ls-files -z`.split("\x0")
+    end
+
+    memoize def config
+      cmd = %w[git config --list]
+      config = SuperHash.new
+      IO.popen(cmd).each do |line|
+        line.chomp!
+        path, _, value = line.partition("=")
+        path = path.split(".").map(&:to_sym)
+        path, assign = path[0...-1], path[-1]
+        (path.reduce(config) {|acc,key| acc[key] })[assign] = value
+      end
+      config
+    end
+
+    memoize def ls_authors
+      authors = `git log > /dev/null 2>&1 && git shortlog -sn`.split("\n").map {|a| a.sub(/^[\d\s]*/, '') }
+      authors = (authors.empty? && [ `git config user.name` ]) || authors
+    end
+  end
+
+end

data/lib/gemspec/version.rb

@@ -0,0 +1,4 @@
+module Gemspec
+  VERSION = File.read(File.expand_path("../VERSION", __FILE__))
+  VERSION_FOR_HUMANS = File.read(File.expand_path("../VERSION_FOR_HUMANS", __FILE__))
+end

data/lib/super_hash.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+# SuperHash is very much like OpenStruct except that it creates whole paths instead of just keys
+#SuperHash is a hash whose default value defaults to another instance of SuperHash
+#which allows for chaining:
+#   super_hash[:x][:y][:z] will create the :x, :y, and :z sub-superhashes
+#Assignment creates signleton accessor methods
+#   super_hash[:x] = 42
+#   super_hash.respond_to? :x == true
+#   super_hash.respond_to? :x= == true
+#Since a bare:
+#   super_hash[:x]
+#*assigns* another superhash if no :x key is found, this alone results in:
+#   super_hash.respond_to?(:x) == true
+#   super_hash.respond_to?(:x=) == true
+#method_missing delegates to either :[] or :[]= (depeding on whether the method name ends with =)
+#so either eventually results in a singleton method definition and you can use dots instead
+#of [] like in JavaScript
+#   super_hash.x.y.z = 42 #This creates the whole chain of hashes and the accessor methods
+
+class SuperHash < Hash
+  def initialize(*args)
+    super(*args) { |hash,key|
+      hash[key] = SuperHash.new
+    }
+  end
+  #Assignment defines accessor methods
+  def []=(key, val)
+    this = self
+    unless respond_to?(key)
+      self.define_singleton_method(key) do
+        this[key]
+      end
+    end
+    unless respond_to?("#{key}=".to_sym)
+      self.define_singleton_method("#{key}=".to_sym) do |v|
+        this[key] = v
+      end
+    end
+    return super(key, val)
+  end
+
+  def method_missing(key, *args)
+    if /=$/ === key
+      key = key.to_s.sub(/=$/,'').to_sym
+      return public_send :[]=, key, *args
+    end
+    return  public_send :[], key, *args
+  end
+end

data/rakelib/gem.rake

@@ -0,0 +1,13 @@
+require 'rubygems/package_task'
+$:.unshift(File.expand_path('../lib',__FILE__))
+
+$gemspec = Gem::Specification.load(Dir["*.gemspec"][0])
+files = Rake::FileList.new(Gemspec::Git.ls_files)
+
+Gem::PackageTask.new($gemspec) { }
+task :gem => :chmod
+task :chmod do
+  files.each do |file|
+    chmod 'o+r', file unless File.world_readable?(file)
+  end
+end

data/rakelib/license.rake

@@ -0,0 +1,19 @@
+directory "LICENSES"
+$gemspec = Gem::Specification.load(Dir["*.gemspec"][0])
+
+file "LICENSES/.info" => "gemspec.gemspec" do |t|
+  mkdir_p "LICENSES"
+
+  licenses_dir = File.expand_path('../../share/gemspec/licenses/', `gem which gemspec`.chomp)
+  $? == 0 or licenses_dir = File.expand_path('licenses/')
+
+  $gemspec.licenses.each do |license|
+    cp File.join(licenses_dir, license), "LICENSES/#{Shellwords.escape license}"
+  end
+  File.write(t.name, "This directory contains the licenses you can use with this gem\n")
+end
+
+desc "Fill LICENSES/ with licenses according to gemspec.gemspec and view them"
+task 'license' => 'LICENSES/.info' do
+  sh "cd LICENSES/; less *"
+end

data/share/gemspec/licenses/AAL

@@ -0,0 +1,27 @@
+
+Attribution Assurance License 
+Copyright (c) 
+2002 by AUTHOR PROFESSIONAL IDENTIFICATION * URL "PROMOTIONAL SLOGAN FOR AUTHOR'S PROFESSIONAL PRACTICE"
+
+All Rights Reserved 
+ATTRIBUTION ASSURANCE LICENSE (adapted from the original BSD license)
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the conditions below are met. These conditions require a modest attribution to 
+<AUTHOR>
+ (the "Author"), who hopes that its promotional value may help justify the thousands of dollars in otherwise billable time invested in writing this and other freely available, open-source software.
+1. Redistributions of source code, in whole or part and with or without modification (the "Code"), must prominently display this GPG-signed text in verifiable form. 
+2. Redistributions of the Code in binary form must be accompanied by this GPG-signed text in any documentation and, each time the resulting executable program or a program dependent thereon is launched, a prominent display (e.g., splash screen or banner text) of the Author's attribution information, which includes: 
+     (a) 
+Name
+ ("AUTHOR"), 
+     (b) 
+Professional identification
+ ("PROFESSIONAL IDENTIFICATION"), and 
+     (c) 
+URL
+ ("URL"). 
+3. Neither the name nor any trademark of the Author may be used to endorse or promote products derived from this software without specific prior written permission. 
+4. Users are entirely responsible, to the exclusion of the Author and any other persons, for compliance with (1) regulations set by owners or administrators of employed equipment, (2) licensing terms of any other software, and (3) local regulations regarding use, including those regarding import, export, and use of encryption software.
+THIS FREE SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR ANY CONTRIBUTOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, EFFECTS OF UNAUTHORIZED OR MALICIOUS NETWORK ACCESS; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+  There is no standard license header for the license
+