rscaffold 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1266e781645b607559f2b3eb06ba49edcb5c9ac6
+  data.tar.gz: fac620a68838f619b9f7d8402e37df0ffd22889e
+SHA512:
+  metadata.gz: a6b34feb80d5ed6ed45b48eba7447d82fb6e43a2a8383cf5fba07b93723ab8afc62859a0235aac2ba5ba121c5edb49d3abaea7f5879ddbe8d24fb940bee2e9da
+  data.tar.gz: f861ac5d10f5d95aca71933374744772a669715810e6a3ed3ed4f83f8b0a4be4a828550dc13d5f73bf8bd91c163efcc0310e7bf7f3f8fa1437703a572818455d

data/README.md

@@ -0,0 +1,35 @@
+rscaffold
+---------
+make a new ruby project.
+rscaffold is a similar concept to jeweler, 
+but is meant to be simpler and smaller.
+
+Installation
+---------
+
+    git clone https://github.com/rscaffold
+    cd rscaffold
+    rake install
+
+(use `sudo` as necessary)
+
+Runtime Requirements
+---------
+ruby >= 1.9.2
+
+Build Requirements
+---------
+rake
+
+Inspiration and History
+---------
+I like automated setup of project scaffolding. 
+I thought jeweler is a little too much.
+
+License
+---------
+© 2014 Noah Birnel
+MIT license
+
+[![Build Status](https://travis-ci.org/nbirnel/rscaffold.png?branch=master)](https://travis-ci.org/nbirnel/rscaffold)
+[![Code Climate](https://codeclimate.com/github/nbirnel/rscaffold.png)](https://codeclimate.com/github/nbirnel/rscaffold)

data/bin/rscaffold

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'rscaffold'
+
+@project_name = ARGV.shift
+
+
+@project = RScaffold::Project.new @project_name
+@project.write_all
+

data/lib/licenses/BSD-2.erb

@@ -0,0 +1,23 @@
+Copyright (c) <%= Time.now.year %> <%= @owner %>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, 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.

data/lib/licenses/MIT.erb

@@ -0,0 +1,19 @@
+Copyright (c) <%= Time.now.year %> <%= @owner %>
+
+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/lib/rscaffold/version.rb

@@ -0,0 +1,17 @@
+module RScaffold
+
+  class Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+    end
+  end
+
+  VERSION = Version.to_s
+
+end

data/lib/rscaffold.rb

@@ -0,0 +1,143 @@
+require 'erb'
+require 'rscaffold/version'
+require 'fileutils'
+include FileUtils
+
+module RScaffold
+
+  def self.camel_case string
+    string.split(/_/).map{|w| w.capitalize}.join ''
+  end
+
+  class Project
+    ATTRS = %w(
+      bin
+      camel
+      codeclimate
+      description
+      email
+      fullname
+      gemversion
+      homepage
+      license
+      location
+      owner
+      remote
+      remote_path
+      rubyver
+      summary
+      travis
+      usage
+      whoami
+    )
+    
+    ATTRS.each{|a| attr_accessor a.to_sym}
+
+    attr_reader :name
+
+    def initialize name
+      @name  = name
+      @bin   = @name
+      @camel = RScaffold.camel_case @name
+
+      @rubyver = '>=1.8.7'
+      @license = 'MIT'
+
+      @today = Time.now.strftime '%Y-%m-%d'
+      @yyyy  = Time.now.year
+
+      # This disgusting thing is to work across *nix, Windows, and Cygwin.
+      @whoami   = ( ENV["USER"] || ENV["USERNAME"] ).sub(/.*\\/, '')
+      @email    = `git config --get user.email`
+      @fullname = `git config --get user.name`
+      @owner    = @fullname
+
+      @remote_path = "#{@whoami}/#{@name}"
+      @remote      = "http://github.com/#{@remote_path}"
+      @homepage    = @remote
+      @travis      = travis_of      @remote_path
+      @codeclimate = codeclimate_of @remote_path
+      @gemversion  = gemversion_of  @name
+
+      @summary     = "!!SUMMARY!!"
+      @description = "!!DESCRIPTION!!"
+      @usage       = "!!USAGE!!"
+
+      @location = {
+        :bin       => "bin/#{@bin}",
+        :gemfile   => "Gemfile",
+        :gemspec   => "#{@name}.gemspec",
+        :gitignore => ".gitignore",
+        :license   => "LICENSE",
+        :man       => "man/man1/#{@bin}.1",
+        :project   => "lib/#{@name}.rb",
+        :rakefile  => "Rakefile",
+        :readme    => "doc-src/README.md",
+        :rspec     => ".rspec",
+        :spec      => "spec/#{@name}_spec.rb",
+        :travis    => ".travis.yml",
+        :version   => "lib/#{@name}/version.rb",
+      }
+
+    end
+
+    def rendered template
+      ERB.new(contents(template), nil, '<>').result binding
+    end
+
+    def write template
+      FileUtils.mkdir_p File.dirname @location[template.to_sym]
+      File.open(@location[template.to_sym], 'w') do |file|
+        file.write rendered template
+      end
+    end
+
+    def write_all
+      @location.keys.each{|template| self.write(template.to_s)}
+    end
+    
+    def licenses_avail
+      l = Dir.entries(licenses).reject{|el| el =~ /^(\.|\.\.)$/}
+      l.map{|fn| fn.sub(/\.erb$/, '')}
+    end
+
+    private
+
+    def travis_of path
+      travis_dir = "https://travis-ci.org/#{path}"
+      "[![Build Status](#{travis_dir}.png?branch=master)](#{travis_dir})"
+    end
+
+    def codeclimate_of path
+      codeclimate_dir = "https://codeclimate.com/github/#{path}"
+      "[![Code Climate](#{codeclimate_dir}.png)](#{codeclimate_dir})"
+    end
+
+    def gemversion_of path
+      gemversion_dir = "https://badge.fury.io/rb/#{path}"
+      "[![Gem Version](#{gemversion_dir}.png)](#{gemversion_dir})"
+    end
+
+    def contents template
+      if template == 'license'
+        filename = @license
+        dir = licenses
+      else
+        filename = template
+        dir = templates
+      end
+      file     = "#{filename}.erb"
+      File.read(File.join(dir, file))
+    end
+
+    def templates
+      File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def licenses
+      File.join(File.dirname(__FILE__), 'licenses')
+    end
+
+  end
+
+end

data/lib/templates/bin.erb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require '<%=@name%>'

data/lib/templates/gemfile.erb

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem 'rake'
+
+group :test do
+  gem 'rspec'
+end

data/lib/templates/gemspec.erb

@@ -0,0 +1,21 @@
+require './lib/<%=@name%>'
+
+Gem::Specification.new do |s|
+  s.name        = '<%=@name%>'
+  s.version     = <%=@camel%>::VERSION
+  s.date        = '<%=@today%>'
+  s.required_ruby_version = '<%@rubyver%>'
+  s.summary     = "<%=@summary%>"
+  s.description = "<%=@description%>"
+  s.authors     = ['<%=@fullname%>']
+  s.email       = '<%=@email%>'
+  s.homepage    = '<%=@homepage%>'
+  s.files       = Dir.glob("{bin,lib,man}/**/*") + [
+    'README.md',
+    '<%=@name%>.gemspec',
+    'spec/<%=@name%>_spec.rb',
+  ]
+  s.has_rdoc    = true
+  s.executables = ['<%=@bin%>']
+  s.license     = '<%=@license%>'
+end

data/lib/templates/gitignore.erb

@@ -0,0 +1,2 @@
+*.gem
+doc/

data/lib/templates/man.erb

@@ -0,0 +1,27 @@
+.TH <%=@bin%> 1 <%=@bin%>\-0.0.0
+.SH NAME
+<%=@bin%> \- <%=@summary%>
+.SH SYNOPSIS
+.B <%=@bin%> <%=@usage%>
+.SH DESCRIPTION
+.B <%=@bin%>
+<%=@description%>
+.SH OPTIONS
+.LP
+.B --help
+Print a brief usage message.
+.SH EXAMPLES
+.LP
+.B <%=@bin%> 
+.SH FILES
+.SH SEE ALSO
+.TP
+.BR ruby(1)
+.TP
+.IR <%=@fixmewebsite%>
+.SH BUGS
+Probably.
+.SH LICENSE
+Copyright <%=@year%> <%=@owner%>
+.sp
+<%=@license%>

data/lib/templates/project.erb

@@ -0,0 +1,17 @@
+module <%=@camel%>
+
+  class Version
+    MAJOR = 0 
+    MINOR = 0 
+    PATCH = 0 
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+    end
+  end
+
+  VERSION = Version.to_s
+
+end

data/lib/templates/rakefile.erb

@@ -0,0 +1,71 @@
+require 'rspec/core/rake_task'
+require 'rake/clean'
+load 'lib/<%=@name%>.rb'
+
+RSpec::Core::RakeTask.new('spec')
+
+VER = <%=@camel%>::VERSION
+PROG = '<%=@name%>'
+NAME = '<%=@bin%>'
+
+LIB  = FileList['lib/*.rb']
+BIN  = FileList['bin/*.rb']
+TEST = FileList['spec/*.rb']
+MAN  = FileList['man/man*/*.?']
+MANFILE = "#{NAME}.1"
+SPEC = "#{PROG}.gemspec"
+GEM  = "#{PROG}-#{VER}.gem"
+CLEAN.include('doc', '*.gem', 'README.md')
+MANDIR = '/usr/local/man/man1/'
+MANDEST = [MANDIR, MANFILE].join '/'
+README = 'README.md'
+READMESRC = 'doc-src/README.md'
+
+task :all => [:spec, :install]
+
+task :default => :spec
+
+task :test => :spec
+
+task :spec 
+
+file 'doc' => LIB  do
+  `rdoc`        #FIXME shell out not cool
+end
+
+task :readme => README
+
+file README =>[READMESRC, MAN].flatten do
+  `cp #{READMESRC} #{README}`
+  `groff -tman -Thtml #{MAN} | sed '/<html/,$!d; /<style/,/<\\/style>/d' >>#{README}`
+end
+
+task :gem => GEM
+
+file GEM => [LIB, BIN, TEST, MAN, SPEC, README].flatten do
+  `gem build #{SPEC}`            #FIXME shell out not cool
+end
+
+task :install => [:install_gem, :install_man]
+
+task :install_gem => GEM do
+  `gem install #{GEM}`            #FIXME shell out not cool
+end
+
+task :install_man => MAN do
+  mkdir_p MANDIR
+  cp MAN, MANDIR
+end
+
+task :push do
+  `git push origin master`            #FIXME shell out not cool
+end
+
+task :publish => :gem do
+  `gem push #{GEM}`            #FIXME shell out not cool
+end
+
+task :uninstall do
+  `gem uninstall #{PROG}`     #FIXME shell out not cool
+  File.delete MANDEST
+end

data/lib/templates/readme.erb

@@ -0,0 +1,44 @@
+<%=@name%>
+---------
+<%=@summary%>
+
+Installation
+---------
+`gem install <%=@name%>`
+
+or, if you want the latest and the greatest, 
+or if you want the man page installed:
+
+    git clone <%=@remote%>
+    cd <%=@name%>
+    rake install
+
+(use `sudo` as necessary)
+
+Runtime Requirements
+---------
+ruby >= <%@rubyver%>
+
+Build Requirements
+---------
+rake
+
+Developer Requirements
+---------
+groff
+
+Inspiration and History
+---------
+<%=@fixme%>
+
+License
+---------
+© <%=@yyyy%> <%=@owner%>
+<%=@license%> license
+
+<%=@travis%>
+<%=@codeclimate%>
+<%=@gemversion%>
+
+Man page
+---------

data/lib/templates/rspec.erb

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/lib/templates/spec.erb

@@ -0,0 +1,8 @@
+# coding: utf-8
+require  "#{File.dirname(__FILE__)}/../lib/<%=@name%>"
+
+describe <%=@camel%> do
+  before do
+  end
+
+end

data/lib/templates/travis.erb

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/lib/templates/version.erb

@@ -0,0 +1,17 @@
+module <%=@camel%>
+
+  class Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 0
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+    end
+  end
+
+  VERSION = Version.to_s
+
+end

data/rscaffold.gemspec

@@ -0,0 +1,22 @@
+require  "#{File.dirname(__FILE__)}/lib/rscaffold/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'rscaffold'
+  s.version     = RScaffold::VERSION
+  s.date        = '2014-03-28'
+  s.required_ruby_version = '>=1.8.7'
+  s.summary     = "make a new ruby project"
+  s.description = "rscaffold is a similar concept to jeweler, 
+    but is meant to be simpler and smaller."
+  s.authors     = ['Noah Birnel']
+  s.email       = 'nbirnel@gmail.com'
+  s.homepage    = 'http://github.com/nbirnel/rscaffold'
+  s.files       = Dir.glob("{bin,lib}/**/*") + [
+    'README.md',
+    'rscaffold.gemspec',
+    'spec/rscaffold_spec.rb'
+  ]
+  s.has_rdoc    = true
+  s.executables = ['rscaffold']
+  s.license     = 'MIT'
+end

data/spec/rscaffold_spec.rb

@@ -0,0 +1,66 @@
+require  "#{File.dirname(__FILE__)}/../lib/rscaffold"
+require 'find'
+include FileUtils
+include FileTest
+include Find
+
+def output_files
+  Find.find('.').select{|f| FileTest.file?(f) }
+end
+
+
+describe RScaffold do
+
+  before(:all) do
+    FileUtils.rm_rf 'test_output'
+    FileUtils.mkdir_p 'test_output'
+    Dir.chdir 'test_output'
+  end
+
+  it 'camelcases a snake_case string' do
+    RScaffold.camel_case('foo_bar_baz').should eq 'FooBarBaz'
+  end
+
+  describe RScaffold::Project do
+
+    before do
+      @output_bin = "#!/usr/bin/env ruby\n\nrequire 'my_project'\n"
+      @p = RScaffold::Project.new 'my_project'
+    end
+    
+    it 'has a name' do
+      @p.name.should eq 'my_project'
+    end
+
+    it 'has a CamelName' do
+      @p.camel.should eq 'MyProject'
+    end
+
+    it 'can have the remote reset' do
+      new_remote = 'https://some/secure/server/my_project'
+      @p.remote = new_remote
+      @p.remote.should eq new_remote 
+    end
+
+    it 'renders templates' do
+      @p.rendered('bin').should eq @output_bin
+    end
+
+    it 'makes destination files' do
+      @p.write('bin')
+      File.read('bin/my_project').should eq @output_bin
+    end
+
+    it 'makes all destination files' do
+      @p.write_all
+      @p.location.length.should eq output_files.length
+    end
+
+    it 'lists all existing licenses' do
+      @p.licenses_avail.length.should be > 1
+    end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: rscaffold
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Noah Birnel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies: []
+description: "rscaffold is a similar concept to jeweler, \n    but is meant to be
+  simpler and smaller."
+email: nbirnel@gmail.com
+executables:
+- rscaffold
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/rscaffold
+- lib/licenses/BSD-2.erb
+- lib/licenses/MIT.erb
+- lib/rscaffold.rb
+- lib/rscaffold/version.rb
+- lib/templates/bin.erb
+- lib/templates/gemfile.erb
+- lib/templates/gemspec.erb
+- lib/templates/gitignore.erb
+- lib/templates/man.erb
+- lib/templates/project.erb
+- lib/templates/rakefile.erb
+- lib/templates/readme.erb
+- lib/templates/rspec.erb
+- lib/templates/spec.erb
+- lib/templates/travis.erb
+- lib/templates/version.erb
+- rscaffold.gemspec
+- spec/rscaffold_spec.rb
+homepage: http://github.com/nbirnel/rscaffold
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: make a new ruby project
+test_files: []