createproj 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 045cb71760b3a2dce81a177942026b9cea4b5e39
+  data.tar.gz: d66ea03637d889ea2ba2572c9a13ec4cab4de875
+SHA512:
+  metadata.gz: ec84be874c255c02bdd44cdf03b33362e505a034b74eabb65a1bdb54d6f6e6f015269b2743d96cbb88a6aa317be8b41f18e112c63992b75116f8244e88b71c41
+  data.tar.gz: cae892efe39e517d58013fe9854b8ea657ff7ac71e7da6a9ebc4b437084bc3816dd38c4ee8a38ff1c285640148e62e5d46919458752d38f2cd782eaf157bb664

data/README.md

@@ -0,0 +1,29 @@
+# CreateProj
+
+## Description
+Quickly create a new project with git respotitory, post commit hooks, and dependencies indended to be included for all projects.
+
+Read more on my [blog](http://mattjmcnaughton.com/createproject).
+
+##
+
+## Steps for building/publish gem
+- From `createproj` directory, run:
+    - `rake gem:build` to build the gem
+    - `rake gem:publish` to publish the gem
+
+## Development
+- Code is linted using rubocop
+- Code is documented using Yardoc
+
+## Assumptions
+I built this largely for my personal use so there are a couple of assumptions made.
+The first is that RVM and Cabal are installed.
+
+## Todo
+- Setup Travis CI
+- Setup test coverage metric and add test
+- Integrate with one of the libraries for git pre-commit hooks?
+    - Multiple pre-commit hooks. Lint and test.
+- Add other languages/frameworks (starting w/ Rails)
+

data/bin/createproj

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# make the load path include ../lib so can require createproj
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'createproj'
+
+# calls start command of Thor
+CreateProj::CLI.start(ARGV)

data/lib/createproj/cli.rb

@@ -0,0 +1,50 @@
+# Namespace for CreateProj
+module CreateProj
+  # Base class for CLI. Provides three project creation methods
+  # dependent on language type.
+  class CLI < Thor
+    # @todo use metaprogramming to simplify this?
+
+    # Command line input option for creating haskell project.
+    #
+    # @param [String] names the project
+    #
+    # @example Call from command line
+    #   $ ./createproj haskell newproj #=> creates haskell proj called new proj
+    #
+    # @return Nothing
+    desc 'haskell NAME', 'create a haskell project called NAME'
+    def haskell(name)
+      CreateProj::Creator::HaskellCreator.new(name, options).run
+    end
+
+    # Command line input option for creating rails project.
+    #
+    # @param [String] names the project
+    #
+    # @example Call from command line
+    #   $ ./createproj haskell newproj #=> creates rails proj called new proj
+    #
+    # @return Nothing
+    desc 'rails NAME', 'create a rails project called NAME'
+    method_option :database, aliases: '-d', desc: 'database to use'
+    method_option :javascript, aliases: '-j', desc: 'javascript library'
+    method_option :skip_test_unit, aliases: '-T', desc: 'skip test unit'
+    def rails(name)
+      CreateProj::Creator::RailsCreator.new(name, options).run
+    end
+
+    # Command line input option for creating ruby project.
+    #
+    # @param [String] names the project
+    #
+    # @example Call from command line
+    #   $ ./createproj ruby newproj #=> creates ruby proj called new proj
+    #
+    # @return Nothing
+    desc 'ruby NAME', 'create a ruby project called NAME'
+    def ruby(name)
+      CreateProj::Creator::RubyCreator.new(name, options).run
+    end
+  end
+end

data/lib/createproj/creator/creator.rb

@@ -0,0 +1,100 @@
+module CreateProj
+  module Creator
+    # Base class for all Creators.
+    #
+    # @attr_reader [String] name description of attributes name
+    # @attr_reader [Hash] options hash of options from command line input
+    class Creator
+      attr_reader :name
+      attr_reader :options
+
+      # Initialize method for class
+      #
+      # @param [String] name projects name
+      # @param [Hash] options command line options for the project
+      #
+      # @return instance of Creator
+      def initialize(name, options)
+        @name = name
+        @options = options
+      end
+
+      # Run instance of creator to create a project with the
+      # name and specified options.
+      #
+      # A subclass of creator can overwrite any of the methods called
+      # in this method if they wish to define a custom behavior
+      #
+      # @example Run an instance of the Creator class
+      #   ruby_creator.run #=> ruby project will be created
+      #
+      # @return nothing but has side effects
+      def run
+        dir_name = create_directory(@name)
+
+        # all remaining ruby commands done from newly created directory
+        Dir.chdir(dir_name) do
+          init_git_repository
+          add_pre_commit_hook(@precommit_template, @precommit_options)
+          install_sandbox
+          install_dependencies
+          extra_setup
+        end
+      end
+
+      # Create a new directory with the given name
+      #
+      # @param [String] name the directory name
+      #
+      # @example Create a new directory
+      #   create_directory("proj") #=> 'proj' (and dir called proj created)
+      #
+      # @return name of directory just created
+      def create_directory(name)
+        Dir.mkdir name
+        # To give flexibility to subclasses
+        name
+      end
+
+      # Initialize a new Git repository in the project directory
+      #
+      # @example Create a Git repository
+      #   init_git_repository #=> git repository created
+      #
+      # @return Git base class (that will not be used)
+      def init_git_repository
+        Git.init
+      end
+
+      # Add a precommit hook based on a template
+      #
+      # @example Add a linting pre commit hook
+      #   add_pre_commit_hook('lint-pre-commit',
+      #      { linter: 'rubocop', file_ext: '.rb'} )
+      #
+      # @return nothing.
+      def add_pre_commit_hook(template, options)
+        template_path = File.join('../../templates', template)
+        hook = Mustache.render(File.read(template_path), options)
+        path_to_git = '.git/hooks/pre-commit'
+
+        # overwrite precommit hook with templated file
+        File.open(path_to_git, 'w+') do |f|
+          f.write(hook)
+        end
+      end
+
+      # overwrite in class
+      def install_sandbox
+      end
+
+      # overwrite in subclass
+      def install_dependencies
+      end
+
+      # intended to be overwritten per class
+      def extra_setup
+      end
+    end
+  end
+end

data/lib/createproj/creator/haskell.rb

@@ -0,0 +1,38 @@
+module CreateProj
+  module Creator
+    # Class for creating Haskell project
+    class HaskellCreator < Creator
+      def initialize(*args)
+        super(*args)
+        @precommit_template = 'lint-pre-commit'
+        @precommit_options = { linter: 'hlint', file_ext: '.hs' }
+      end
+
+      # Create an Haskell sandbox
+      #
+      # @example Create rvm sandbox for project named test
+      #   install_sandbox #=> Executes `cabal sandbox init`
+      #
+      # @return Nothing
+      def install_sandbox
+        system('cabal sandbox init')
+      end
+
+      # Installs dependencies in the new cabal sandbox
+      #
+      # @example Installs rubocop in the gemset sandbox
+      #   install_dependencies #=> happy & hlint installed in the gemset
+      #
+      # @return Nothing
+      def install_dependencies
+        cabals_to_install = %w(happy hlint)
+
+        system('cabal update')
+
+        cabals_to_install.each do |g|
+          system("cabal install #{g}")
+        end
+      end
+    end
+  end
+end

data/lib/createproj/creator/rails.rb

@@ -0,0 +1,17 @@
+module CreateProj
+  module Creator
+    # Class for creating Rails project
+    class RailsCreator < RubyCreator
+      def initialize
+        super
+        @precommit_template = 'lint-pre-commit'
+        @precommit_options = { linter: 'rubocop', file_ext: '.rb' }
+      end
+
+      # @todo - write for rails
+      def run
+        puts 'Coming soon!'
+      end
+    end
+  end
+end

data/lib/createproj/creator/ruby.rb

@@ -0,0 +1,44 @@
+module CreateProj
+  module Creator
+    # Class for creating Ruby project
+    class RubyCreator < Creator
+      def initialize(*args)
+        super(*args)
+        @precommit_template = 'lint-pre-commit'
+        @precommit_options = { linter: 'rubocop', file_ext: '.rb' }
+      end
+
+      # Create an rvm gemset with the project name and
+      # creates file dictating gemset
+      #
+      # @todo - make it so can specify ruby version
+      #
+      # @example Create rvm sandbox for project named test
+      #   install_sandbox #=> Executes `rvm gemset create test`
+      #
+      # @return Nothing
+      def install_sandbox
+        RVM.gemset_create @name
+        RVM.gemset_use @name
+
+        File.open('.ruby-gemset', 'w+') do |f|
+          f.write(@name)
+        end
+      end
+
+      # Installs dependencies in the new sandbox
+      #
+      # @example Installs rubocop in the gemset sandbox
+      #   install_dependencies #=> rubocop is no installed in the gemset
+      #
+      # @return Nothing
+      def install_dependencies
+        gems_to_install = %w(rubocop)
+
+        gems_to_install.each do |g|
+          system("gem install #{g}")
+        end
+      end
+    end
+  end
+end

data/lib/createproj/version.rb

@@ -0,0 +1,5 @@
+# Namespace for CreateProj
+module CreateProj
+  # Version number for the gem - make it only load once
+  VERSION ||= '0.0.2'
+end

data/lib/createproj.rb

@@ -0,0 +1,13 @@
+# require all files needed for createproj
+require 'git'
+require 'mustache'
+require 'rvm'
+require 'thor'
+
+require 'createproj/version'
+require 'createproj/cli'
+
+require 'createproj/creator/creator'
+require 'createproj/creator/haskell'
+require 'createproj/creator/ruby'
+require 'createproj/creator/rails'

data/templates/lint-pre-commit

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+# taking this
+
+require 'english'
+require 'rubocop'
+
+ADD_OR_MOD = /A|AM|^M/
+
+all_added_or_mod = `git status --porcelain`.split(/\n/).select do |fn|
+  fn =~ ADD_OR_MOD
+end
+
+split = all_added_or_mod.map do |fn|
+  fn.split(' ')[1]
+end
+
+changed_files_arr = split.select do |fn|
+  File.extname(fn) == '{{ file_ext }}'
+end
+
+changed_files = changed_files_arr.join(' ')
+
+system("{{ linter }} #{changed_files}") unless changed_files_arr.empty?
+exit $CHILD_STATUS.to_s[-1].to_i

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: createproj
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Matt McNaughton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.28'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.99.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.99.8
+- !ruby/object:Gem::Dependency
+  name: rvm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.11.3.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.11.3.9
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+description: Simple project creation gem.
+email:
+- mattjmcnaughton@gmail.com
+executables:
+- createproj
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/createproj
+- lib/createproj.rb
+- lib/createproj/cli.rb
+- lib/createproj/creator/creator.rb
+- lib/createproj/creator/haskell.rb
+- lib/createproj/creator/rails.rb
+- lib/createproj/creator/ruby.rb
+- lib/createproj/version.rb
+- templates/lint-pre-commit
+homepage: https://github.com/mattjmcnaughton/createproj
+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: 1.3.6
+requirements: []
+rubyforge_project: createproj
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gem to make project creation easier!
+test_files: []
+has_rdoc: