createproj 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce879aa2ccb1c26f3c594c5a1491469aa0d53efe
-  data.tar.gz: 066aa7e8ecbc2f812c9110e6588864d7de7c0c13
+  metadata.gz: 109bef4359c5185cba4e3dd9fee61ba6c50b3cc8
+  data.tar.gz: 4493e7837fa58c48745dbf197b2d796561d5dd82
 SHA512:
-  metadata.gz: 3850a0bab57d66cb9aadd4decc954ffac0a68eeec00c56ed8e89c7a69e415ba684e365da2fd6a7baad2e50a0b0d1c71fc740a54627f08c75b25b9324ba71cfc0
-  data.tar.gz: 50a7d6ab776a60409ff20f30059ed5e93e873a70f1256ab45006ec04af5eccdb1b98475c375d60a3a9b1f4834c8e10045db2bbb517c170fb2b58135760b10817
+  metadata.gz: 8d100bb9ea1fdd577bb8d73fd56cb47b910d3b04329f5636976b62b096fc47dfcd48c3e915b6bda1a59b752e1fcccb666feab744845287df88d41017ddf73d3e
+  data.tar.gz: 9050d835d6c6686c56f7a3e94b3b16059a1b0a5e1fa19fb2b8f809da4d6cc8e24aad5b37093fdafc2132edb28ff2cff5d0ac837ce91778b7d1eec73710f90728

data/README.md

@@ -1,11 +1,30 @@
 # CreateProj
 
+[![Gem Version](https://badge.fury.io/rb/createproj.svg)](http://badge.fury.io/rb/createproj)
+[![Build Status](https://travis-ci.org/mattjmcnaughton/createproj.svg?branch=master)](https://travis-ci.org/mattjmcnaughton/createproj)
+[![Code Climate](https://codeclimate.com/github/mattjmcnaughton/createproj/badges/gpa.svg)](https://codeclimate.com/github/mattjmcnaughton/createproj)
+[![Coverage Status](https://img.shields.io/coveralls/mattjmcnaughton/createproj.svg)](https://coveralls.io/r/mattjmcnaughton/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).
 
-##
+## Usage
+
+Download the gem with `gem install createproj`
+
+To create proj, run `createproj [ruby|haskell] PROJ_NAME` in the directory you want your project created.
+
+Remember, as of now, createproj assumes that you have both rvm and cabal installed.
+
+Once run, createproj will:
+- Create the project directory
+- Initialize a git repository with a language specified .gitignore and language specified git pre-commit hook (right now both are linters)
+- Create a sandbox
+    - rvm gemset for ruby, cabal sandbox for haskell
+- Install default dependencies in the sandbox
+    - rubocop, yard, rspec for ruby and happy, hlint for haskell
 
 ## Steps for building/publish gem
 - From `createproj` directory, run:

data/lib/createproj/creator/creator.rb

@@ -14,7 +14,7 @@ module CreateProj
       # @param [Hash] options command line options for the project
       #
       # @return instance of Creator
-      def initialize(name, options)
+      def initialize(name, options = {})
         @name = name
         @options = options
         @precommit_template = ''
@@ -70,8 +70,29 @@ module CreateProj
         Git.init
       end
 
+      # Add a list of files from @gitignore_files
+      #
+      # @param [Array] ignore_files array of file_names to write to .gitignore
+      #
+      # @example Gitignore files to haskell
+      #   gitignore(['cabal.sandbox.config']) #=> writes .gitignore file
+      #
+      # @return nothing
+      def gitignore(ignore_files)
+        return if ignore_files.empty?
+
+        File.open('.gitignore', 'w+') do |f|
+          ignore_files.each do |gf|
+            f.write("#{gf}\n")
+          end
+        end
+      end
+
       # Add a precommit hook based on a template
       #
+      # @param [String] template  name of the template file
+      # @param [Hash] options hash to fill in the template
+      #
       # @example Add a linting pre commit hook
       #   add_pre_commit_hook('lint-pre-commit',
       #      { linter: 'rubocop', file_ext: '.rb'} )
@@ -102,19 +123,6 @@ module CreateProj
       def install_dependencies
       end
 
-      # Add a list of files from @gitignore_files
-      #
-      # @example
-      def gitignore(ignore_files)
-        return if ignore_files.empty?
-
-        File.open('.gitignore', 'w+') do |f|
-          ignore_files.each do |gf|
-            f.write("#{gf}\n")
-          end
-        end
-      end
-
       # intended to be overwritten per class
       def extra_setup
       end

data/lib/createproj/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: createproj
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Matt McNaughton
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.18.1
 description: Simple project creation gem.
 email:
 - mattjmcnaughton@gmail.com