createproj 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 109bef4359c5185cba4e3dd9fee61ba6c50b3cc8
-  data.tar.gz: 4493e7837fa58c48745dbf197b2d796561d5dd82
+  metadata.gz: 945ead0d57ea958c1bf510d11ebe76ac277b4a4d
+  data.tar.gz: c51491e2687ce04a00183466822c4cfc49a494d9
 SHA512:
-  metadata.gz: 8d100bb9ea1fdd577bb8d73fd56cb47b910d3b04329f5636976b62b096fc47dfcd48c3e915b6bda1a59b752e1fcccb666feab744845287df88d41017ddf73d3e
-  data.tar.gz: 9050d835d6c6686c56f7a3e94b3b16059a1b0a5e1fa19fb2b8f809da4d6cc8e24aad5b37093fdafc2132edb28ff2cff5d0ac837ce91778b7d1eec73710f90728
+  metadata.gz: 1784da067adbd2c9b48aa601d7cae5d5a7d6b267d6328126a4bc5064e2000008cf71b222daf653a985b167b9a0435cc4007f84750ef6c5ceb0f0c3cf735b9959
+  data.tar.gz: ef94d407e6900715ee8ec636883292bc5156ffe4d7d19af8dfc3bb97ae63e3e5e454da3169e1f0d62ca453f8d7add44a9639b56746ae814c2489e84aa81690fa

data/README.md

@@ -22,9 +22,13 @@ 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
+    - Ruby: rvm gemset
+    - Haskell: cabal sandbox
+    - Python: virtualenv environment
 - Install default dependencies in the sandbox
-    - rubocop, yard, rspec for ruby and happy, hlint for haskell
+    - Ruby: rubocop, yard, rspec
+    - Haskell: happy, hlint
+    - Python: pylint,
 
 ## Steps for building/publish gem
 - From `createproj` directory, run:
@@ -35,8 +39,17 @@ Once run, createproj will:
 - 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.
+## Dependencies
+For each language, I assume certain dependencies:
+- Ruby
+    - [Rvm](https://rvm.io/)
+- Haskell
+    - [Cabal](https://www.haskell.org/cabal/)
+- Python
+    - [virtualenv](https://virtualenv.pypa.io/en/latest/), [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/index.html)
+        - I also assume that [this](https://gist.github.com/mattjmcnaughton/4d599b62b60b59f9229f) virtualenv script is sourced. If not, instructions will be given to install.
+
+## Contributing
+Please do! Let me know if I can be of any help!
 
 

data/lib/createproj/cli.rb

@@ -18,6 +18,19 @@ module CreateProj
       CreateProj::Creator::HaskellCreator.new(name, options).run
     end
 
+    desc 'python NAME', 'create a python project called NAME'
+    # Command line input option for creating python project.
+    #
+    # @param [String] name the project
+    #
+    # @example Call from command line
+    #   $ ./createproj python newproj #=> creates python proj called newproj
+    #
+    # @return Nothing
+    def python(name)
+      CreateProj::Creator::PythonCreator.new(name, options).run
+    end
+
     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'

data/lib/createproj/creator/python.rb

@@ -0,0 +1,92 @@
+module CreateProj
+  module Creator
+    # Class for creating Ruby project
+    class PythonCreator < Creator
+      def initialize(*args)
+        super(*args)
+        @precommit_template = 'lint-pre-commit'
+        @precommit_options = { linter: 'pylint', file_ext: '.py' }
+        @gitignore_files = %w(*.pyc)
+        @packages_to_install = {
+          'pylint' => '1.4.0'
+        }
+      end
+
+      # Creates a namespaced virtualenv name
+      #
+      # @example Get virtualenv name if project name is test
+      #   virtualenv_name #=> 'test-createproj'
+      #
+      # @return [String] that has unique integer name
+      def virtualenv_name
+        "#{@name}-createproj"
+      end
+
+      # Write a .venv file with the name of the virtualenv
+      #
+      # @example
+      #   write_venv_file #=> `cat .venv` #=> NAME
+      #
+      # @return Nothing
+      def write_venv_file
+        # must have both .ruby-gemset and .ruby-version file
+        File.open('.venv', 'w+') do |f|
+          f.write(virtualenv_name)
+        end
+      end
+
+      # Check that a bash script
+      def check_bash_script
+        command = <<-eos
+          If you want the virtual env to be automatically activated
+          upon entering the directory, follow the instructions in
+          this gist (https://gist.github.com/mattjmcnaughton/4d599b62b60b59f9229f).
+        eos
+
+        puts command unless File.exist?(File.join("#{Dir.home}",
+                                                  '.virtualenv_sourcer'))
+      end
+
+      # Create an virtualenv with the project name and
+      # creates file dictating virtualenv
+      #
+      # @todo Automate creating the virtualenv
+      #
+      # Check that the user has installed a bash script
+      # that will automatically `workon ENV` when entering
+      # directory with a .venv file
+      #
+      # @example Create rvm sandbox for project named test
+      #   install_sandbox #=> Executes `mkvirtualenv NAME`, write .env file,
+      #                       and check for bash script
+      #
+      # @return Nothing
+      def install_sandbox
+        # make system call to virtualenvwrapper to create the virtualenv
+        command = "Run mkvirtualenv #{virtualenv_name}"
+
+        puts command
+        write_venv_file
+        check_bash_script
+      end
+
+      # Installs dependencies in the new sandbox
+      #
+      # @example Write pylint to a requirements.txt and
+      #          prompt `pip install -r requirements.txt`
+      #   install_dependencies #=> pylint written in Gemfile
+      #
+      # @return Nothing
+      def install_dependencies
+        File.open('requirements.txt', 'w+') do |f|
+          @packages_to_install.each do |k, v|
+            f.write("#{k}==#{v}\n")
+          end
+        end
+
+        command = 'Enter the directory and run pip install requirements.txt'
+        puts command
+      end
+    end
+  end
+end

data/lib/createproj/creator/ruby.rb

@@ -8,6 +8,11 @@ module CreateProj
         @precommit_options = { linter: 'rubocop', file_ext: '.rb' }
         @gitignore_files = %w(.ruby-gemset .ruby-version .bundle
                               Gemfile.lock doc .yardoc)
+
+        @gems_to_install = {
+          'rubocop' => '0.28', 'rspec' => '3.0', 'yard' => '0.8'
+        }
+        @default_ruby_version = '2.0.0'
       end
 
       # Creates a namespaced gemset name to avoid overwriting of gemsets
@@ -20,30 +25,41 @@ module CreateProj
         "#{@name}-createproj"
       end
 
-      # Create an rvm gemset with the project name and
-      # creates file dictating gemset
+      # Write the .ruby-gemset and .ruby-version rvm files
       #
       # @todo - make it so can specify ruby version
       #
-      # @example Create rvm sandbox for project named test
-      #   install_sandbox #=> Executes `rvm gemset create test`
+      # @example
+      #   write_rvm_files #=> # writes the two files
       #
       # @return Nothing
-      def install_sandbox
-        RVM.gemset_create(gemset_name)
-
+      def write_rvm_files
         # must have both .ruby-gemset and .ruby-version file
         File.open('.ruby-gemset', 'w+') do |f|
           f.write(gemset_name)
         end
 
         # @todo - make this an option
-        default_ruby_version = '2.0.0'
+
         File.open('.ruby-version', 'w+') do |f|
-          f.write(default_ruby_version)
+          f.write(@default_ruby_version)
         end
       end
 
+      # Create an rvm gemset with the project name and
+      # creates file dictating gemset
+
+      #
+      # @example Create rvm sandbox for project named test
+      #   install_sandbox #=> Executes `rvm gemset create test`
+      #
+      # @return Nothing
+      def install_sandbox
+        RVM.gemset_create(gemset_name)
+
+        write_rvm_files
+      end
+
       # Installs dependencies in the new sandbox
       #
       # @example Write rubocop to a gemfile and prompt `bundle install`
@@ -51,18 +67,15 @@ module CreateProj
       #
       # @return Nothing
       def install_dependencies
-        gems_to_install = {
-          'rubocop' => '0.28', 'rspec' => '3.0', 'yard' => '0.8'
-        }
-
         File.open('Gemfile', 'w+') do |f|
           f.write("source 'https://rubygems.org'\n\n")
-          gems_to_install.each do |k, v|
+          @gems_to_install.each do |k, v|
             f.write("gem '#{k}', '~> #{v}'\n")
           end
         end
 
-        puts 'Enter the directory and run bundle install.'
+        command = 'Enter the directory and run bundle install.'
+        puts command
       end
     end
   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.1.0'
+  VERSION ||= '0.1.1'
 end

data/lib/createproj.rb

@@ -12,3 +12,4 @@ require 'createproj/creator/creator'
 require 'createproj/creator/haskell'
 require 'createproj/creator/ruby'
 require 'createproj/creator/rails'
+require 'createproj/creator/python'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: createproj
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Matt McNaughton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-28 00:00:00.000000000 Z
+date: 2015-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -164,6 +164,7 @@ files:
 - lib/createproj/cli.rb
 - lib/createproj/creator/creator.rb
 - lib/createproj/creator/haskell.rb
+- lib/createproj/creator/python.rb
 - lib/createproj/creator/rails.rb
 - lib/createproj/creator/ruby.rb
 - lib/createproj/version.rb