learn-generate 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cd0170eb73ddeb9d7a50161cc2a887c0962bd3b
+  data.tar.gz: 7d985e95eeef7de156b5c87dce9e6e75fd183205
+SHA512:
+  metadata.gz: e84575e41b5d07098e3bee1ec72d4e9d4f4560b6deb00935751f29dbce94afdc3d97632551e9b32e6828458ebab7621831fc1a280bac60a65cdbe5eb07904399
+  data.tar.gz: f756e2306be30f27087fba1652b3dd091ae581d5c736ac459accfc4d68148d08be055cd54eb4936c38429089c58e68b465e7d550495ddfb65de9e22969cefb22

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014-2015 The Flatiron School
+
+MIT License
+
+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/README.md

@@ -0,0 +1,54 @@
+# Flatiron Lab Generator
+
+A gem for generating labs in the format/style we use for making labs at the Flatiron School.
+
+## Dependencies
+
+Assumes installation of git.
+
+## Installation
+
+Visit [http://gems.flatironschool.com/](http://gems.flatironschool.com/)
+
+## Usage
+
+`flatiron-lab-generator <lab-type> <lab-name>`
+
+### With git
+
+Execute as `flatiron-lab-generator <lab-type> <lab-name> -g` if you want your template to be created with an initialized git repository.
+
+## Lab Types
+
+Lab types have been outlined in the [Curriculum Style Guide](https://github.com/learn-co-curriculum/curriculum-style-guide/blob/master/lab-templates.md)
+
+These are the Lab Types:
+
+* fundamental-ruby
+* command-line
+* SQL
+* activerecord
+* rake
+* rack
+* sinatra-classic
+* sinatra-mvc
+* js
+* front-end
+* kids
+
+We have the [flatiron-rails gem](https://github.com/flatiron-school/flatiron-rails) for generating Rails labs.
+
+## Lab Name
+
+The lab-name refers to the name of the lab (example: Sinatra-ORM-Halloween).
+
+## Reposit
+
+Logan made an awesome gem that creates a remote git repository from the command line. It's called [Reposit](https://github.com/loganhasson/reposit). After installing that and following the setup steps, run `reposit <lab name> -o learn-co-curriculum`.
+
+## Contributing
+
+1. Clone
+2. Checkout a new feature branch
+3. Be sure to run the tests
+4. Open PR

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/learn-generate

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require 'learn_generate'
+
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.on('--list', 'List known templates') do |l|
+    options[:list] = true
+  end
+
+  opts.on('--internet', 'Perform actions with an internet connection') do |i|
+    options[:internet] = true
+  end
+end.parse!
+
+template_loader = LearnGenerate::TemplateLoader.new(options[:internet])
+known_templates = template_loader.templates
+templates_list  = template_loader.printable_list
+
+my_banner = <<-EOS
+
+  Usage: learn generate <lab-name> -t <template-name>
+
+  Available templates:
+
+  #{templates_list}
+EOS
+
+if options[:list]
+  puts <<-EOS
+  Available templates:
+
+  #{templates_list}
+  EOS
+elsif !ARGV[0] || !ARGV[1]
+  puts my_banner
+elsif !known_templates.include?(ARGV[0])
+  puts my_banner
+else
+  LearnGenerate::TemplateMaker.run(ARGV[0], ARGV[1])
+end

data/learn-generate.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'learn_generate/version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = "learn-generate"
+  spec.version       = LearnGenerate::VERSION
+  spec.authors       = ["Flatiron School"]
+  spec.email         = ["learn@flatironschool.com"]
+  spec.summary       = %q{A lab generator}
+  spec.description   = %q{Generates labs for Learn.co based on a set of lab templates}
+  spec.homepage      = "https://learn.co"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", "bin"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/learn_generate/file_finder.rb

@@ -0,0 +1,19 @@
+module LearnGenerate
+  class FileFinder
+    def self.location_to_dir(dir_name)
+      new.location_to_dir(dir_name)
+    end
+
+    def location_to_dir(dir_name)
+      File.join(File.dirname(File.expand_path(__FILE__)), "#{dir_name}")
+    end
+
+    def self.location_to_file(file_name)
+      new.location_to_file(file_name)
+    end
+
+    def location_to_file(file_name)
+      File.join(File.dirname(File.expand_path(__FILE__)))
+    end
+  end
+end

data/lib/learn_generate/helpers/dot-learn-helper.rb

@@ -0,0 +1,12 @@
+module LearnGenerate
+  module Helpers
+    module DotLearnHelper
+      def build_dot_learn
+        File.open('.learn', 'a') do |f|
+          f << "languages:
+    tags:"
+        end
+      end
+    end
+  end
+end

data/lib/learn_generate/helpers/gemfile-helper.rb

@@ -0,0 +1,48 @@
+module LearnGenerate
+  module Helpers
+    module GemfileHelper
+      def edit_mvc_gemfile
+        File.open("Gemfile", 'a') do |f|
+          f << "\ngem 'sinatra'
+    gem 'activerecord', :require => 'active_record'
+    gem 'sinatra-activerecord', :require => 'sinatra/activerecord'
+    gem 'rake'
+    gem 'require_all'
+    gem 'sqlite3'
+    gem 'thin'
+    gem 'shotgun'
+    gem 'pry'
+    \ngroup :test do
+      gem 'rspec'
+      gem 'capybara'
+      gem 'rack-test'
+      gem 'database_cleaner', git: 'https://github.com/bmabey/database_cleaner.git'
+    end"
+        end
+      end
+
+      def edit_classic_gemfile
+        File.open("Gemfile", 'a') do |f|
+          f << "\ngem 'sinatra'
+    gem 'rake'
+    gem 'thin'
+    gem 'shotgun'
+    gem 'pry'
+    gem 'require_all'
+    \ngroup :test do
+      gem 'rspec'
+      gem 'capybara'
+      gem 'rack-test'
+    end"
+        end
+      end
+
+      def edit_gemfile
+        File.open("Gemfile", 'a') do |f|
+          f << "\ngem 'rspec'
+    gem 'pry'"
+        end
+      end
+    end
+  end
+end

data/lib/learn_generate/helpers/template-helper.rb

@@ -0,0 +1,52 @@
+module LearnGenerate
+  module Helpers
+    module TemplateHelper
+      def fundamental_helper
+        change_filename('lib/', 'file.rb', 'rb')
+        edit_file('spec/spec_helper.rb', formatted_lab_name)
+        edit_gemfile
+      end
+
+      def command_line_helper
+        edit_file("bin/runner.rb", formatted_lab_name)
+        edit_file("spec/spec_helper.rb", formatted_lab_name)
+        edit_file("lib/environment.rb", formatted_lab_name)
+        FileUtils.mv("lib/lab-name", "lib/#{lab_name}")
+        edit_gemfile
+      end
+
+      def sql_helper
+        change_filename('lib/', 'sample.sql', 'sql')
+      end
+
+      def rake_helper
+        change_filename('lib/', 'file.rb', 'rb')
+        edit_file("config/environment.rb", formatted_lab_name)
+        edit_gemfile
+      end
+
+      def sinatra_mvc_helper
+        edit_mvc_gemfile
+      end
+
+      def sinatra_classic_helper
+        edit_classic_gemfile
+      end
+
+      def js_helper
+        change_filename('js/', 'file.js', 'js')
+      end
+
+      def fe_helper
+        edit_file('index.html', formatted_name)
+      end
+
+      def kids_helper
+        change_filename('lib/', 'file.rb', 'rb')
+        edit_file('spec/spec_helper.rb', formatted_lab_name)
+        edit_spec("spec/#{formatted_lab_name}_spec.rb")
+        edit_gemfile
+      end
+    end
+  end
+end

data/lib/learn_generate/template_loader.rb

@@ -0,0 +1,96 @@
+module LearnGenerate
+  class TemplateLoader
+    attr_reader   :internet, :local_path, :local_dir
+    attr_accessor :templates
+
+    BASE_TEMPLATES = [
+      'fundamental-ruby',
+      'command-line',
+      'sql',
+      'activerecord',
+      'rake',
+      'erb-static-site',
+      'rack',
+      'sinatra-classic',
+      'sinatra-mvc',
+      'js',
+      'front-end',
+      'kids'
+    ]
+
+    def initialize(internet)
+      @internet   = internet
+      @local_dir  = File.expand_path('~/.learn-generate')
+      @local_path = File.expand_path('~/.learn-generate/templates')
+
+      set_templates
+    end
+
+    def printable_list
+      templates.map.with_index do |template, index|
+        "#{index+1}. #{template}"
+      end.join("\n  ")
+    end
+
+    private
+
+    def set_templates
+      if internet
+        if has_local_copy?
+          get_and_update_templates
+        else
+          prep_local_copy
+          get_and_update_templates(silent: true)
+        end
+      elsif has_local_copy?
+        update_local_templates
+      else
+        set_base_templates
+      end
+    end
+
+    def prep_local_copy
+      create_local_dir
+      clone_templates_repo
+    end
+
+    def create_local_dir
+      FileUtils.mkdir_p(local_dir)
+    end
+
+    def clone_templates_repo
+      puts 'Pulling list of known templates...'
+      system("cd #{local_dir} && git clone https://github.com/learn-co-curriculum/learn-generate-templates.git templates")
+    end
+
+    def get_and_update_templates(silent: false)
+      get_latest_templates(silent: silent)
+      update_local_templates
+    end
+
+    def get_latest_templates(silent: false)
+      puts 'Updating templates...' if !silent
+      system("cd #{local_path} && git pull --rebase --quiet")
+    end
+
+    def update_local_templates
+      self.templates = Dir.entries("#{local_path}/templates").reject {|f| f.start_with?('.') || !File.directory?("#{local_path}/templates/#{f}")}
+    end
+
+    def set_base_templates
+      self.templates = BASE_TEMPLATES
+    end
+
+    def has_local_copy?
+      has_templates_dir? && templates_dir_is_git_repo?
+    end
+
+    def has_templates_dir?
+      File.exists?(local_path) && File.directory?(local_path)
+    end
+
+    def templates_dir_is_git_repo?
+      File.exists?("#{local_path}/.git") && File.directory?("#{local_path}/.git")
+    end
+  end
+end

data/lib/learn_generate/template_maker.rb

@@ -0,0 +1,115 @@
+module LearnGenerate
+  class TemplateMaker
+    include LearnGenerate::Helpers::TemplateHelper
+    include LearnGenerate::Helpers::GemfileHelper
+    include LearnGenerate::Helpers::DotLearnHelper
+
+    attr_reader :template_type, :lab_name, :has_templates_dir, :full_templates_path
+
+    def initialize(template_type, lab_name)
+      @template_type = template_type
+      @lab_name = lab_name
+      templates_path     = File.expand_path('~/.learn-generate/templates')
+      templates_git_path = File.expand_path('~/.learn-generate/templates/.git')
+      @has_templates_dir = File.exists?(templates_path) && File.directory?(templates_path) && File.exists?(templates_git_path) && File.directory?(templates_git_path)
+      @full_templates_path = templates_path + '/templates'
+    end
+
+    def self.run(template_type, lab_name)
+      new(template_type, lab_name).create
+    end
+
+    def create
+      copy
+      name_lab
+      FileUtils.cd("#{lab_name}") do
+        touch_spec unless template_type == "js" || template_type == "sinatra-mvc" || template_type == "front-end"
+        touch_dot_learn
+        build_dot_learn
+        git_init
+        bundle_init unless template_type == "js" || template_type == "front-end"
+        edit_readme
+        fundamental_helper if template_type == "fundamental-ruby"
+        command_line_helper if template_type == "command-line"
+        sql_helper if template_type == "SQL"
+        rake_helper if template_type == "rake"
+        sinatra_mvc_helper if template_type == "sinatra-mvc"
+        sinatra_classic_helper if template_type == "sinatra-classic"
+        js_helper if template_type == "js"
+        fe_helper if template_type == "front-end"
+        kids_helper if template_type == "kids"
+      end
+      success_message
+    end
+
+    def copy
+      if has_templates_dir
+        FileUtils.cp_r("#{full_templates_path}/#{template_type}", FileUtils.pwd)
+      else
+        FileUtils.cp_r(LearnGenerate::FileFinder.location_to_dir("../templates/#{template_type}"), FileUtils.pwd)
+      end
+    end
+
+    def name_lab
+      FileUtils.mv(template_type, lab_name)
+    end
+
+    def git_init
+      `git init`
+    end
+
+    def edit_readme
+      File.open("README.md", 'a') do |f|
+        f << "\n# #{formatted_name}"
+      end
+    end
+
+    def formatted_name
+      lab_name.gsub('-', ' ').split.map(&:capitalize).join(' ')
+    end
+
+    def formatted_lab_name
+      lab_name.gsub('-', '_')
+    end
+
+    def bundle_init
+      `bundle init`
+    end
+
+    def touch_spec
+      FileUtils.cd("spec/") do
+        `touch #{formatted_lab_name}_spec.rb`
+      end
+    end
+
+    def touch_dot_learn
+      `touch .learn`
+    end
+
+    def change_filename(path, filename, extension)
+      FileUtils.cd(path) do
+        File.rename(filename, "#{formatted_lab_name}.#{extension}")
+      end
+    end
+
+    def edit_file(file, text)
+      new_rr = IO.read(file) % { file_name: text }
+      File.open(file, 'w') { |f| f.write(new_rr) }
+    end
+
+    def edit_spec(file)
+      File.open(file, 'w') { |f| f.write("require_relative './spec_helper'") }
+    end
+
+    def success_message
+      puts "\n#{formatted_name} Lab successfully created in #{FileUtils.pwd}\n"
+      FileUtils.cd("#{lab_name}") do
+        tree_output = `which tree 2>/dev/null`
+
+        if !tree_output.empty?
+          puts "#{`tree`}"
+        end
+      end
+    end
+  end
+end

data/lib/learn_generate/version.rb

@@ -0,0 +1,3 @@
+module LearnGenerate
+  VERSION = '1.0.0'
+end

data/lib/learn_generate.rb

@@ -0,0 +1,10 @@
+require 'fileutils'
+require 'optparse'
+
+require 'learn_generate/version.rb'
+require 'learn_generate/helpers/template-helper'
+require 'learn_generate/helpers/gemfile-helper'
+require 'learn_generate/helpers/dot-learn-helper'
+require 'learn_generate/file_finder'
+require 'learn_generate/template_loader'
+require 'learn_generate/template_maker'

data/lib/templates/activerecord/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/lib/templates/activerecord/README.md

@@ -0,0 +1,5 @@
+---
+tags: 
+languages: 
+resources: 
+---

data/lib/templates/activerecord/Rakefile

@@ -0,0 +1,22 @@
+task :environment do
+  ENV["ACTIVE_RECORD_ENV"] ||= "development"
+  require_relative './config/environment'
+end
+
+namespace :db do
+  task :migrate => :environment do
+    DB.tables.each do |table|
+      DB.execute("DROP TABLE #{table}")
+    end
+
+    Dir[File.join(File.dirname(__FILE__), "db/migrations", "*.rb")].each do |f| 
+      require f
+      migration = Kernel.const_get(f.split("/").last.split(".rb").first.gsub(/\d+/, "").split("_").collect{|w| w.strip.capitalize}.join())
+      migration.migrate(:up)
+    end
+  end
+end
+
+task :console => "db:migrate" do
+  Pry.start
+end

data/lib/templates/activerecord/app/models/sample-class.rb

@@ -0,0 +1,2 @@
+class NameOfClass < ActiveRecord::Base
+end

data/lib/templates/activerecord/config/environment.rb

@@ -0,0 +1,26 @@
+require 'bundler/setup'
+Bundler.require
+
+require 'rake'
+require 'active_record'
+require 'yaml/store'
+require 'ostruct'
+
+DBNAME = "set_db_name"
+
+Dir[File.join(File.dirname(__FILE__), "../app/models", "*.rb")].each {|f| require f}
+Dir[File.join(File.dirname(__FILE__), "../lib/support", "*.rb")].each {|f| require f}
+
+DBRegistry[ENV["ACTIVE_RECORD_ENV"]].connect!
+DB = ActiveRecord::Base.connection
+
+if ENV["ACTIVE_RECORD_ENV"] == "test"
+  ActiveRecord::Migration.verbose = false
+end
+
+RAKE_APP ||= begin
+  app = Rake.application
+  app.init
+  app.load_rakefile
+  app
+end

data/lib/templates/activerecord/lib/support/connection_adapter.rb

@@ -0,0 +1,15 @@
+class ConnectionAdapter
+  attr_reader :adapter, :database
+
+  def initialize(database, adapter="sqlite3")
+    @adapter = adapter
+    @database = database
+  end
+
+  def connect!
+    ActiveRecord::Base.establish_connection(
+      :adapter => self.adapter,
+      :database => self.database
+    )
+  end
+end

data/lib/templates/activerecord/lib/support/db_registry.rb

@@ -0,0 +1,4 @@
+DBRegistry ||= OpenStruct.new(test: ConnectionAdapter.new("db/#{DBNAME}-test.db"), 
+  development: ConnectionAdapter.new("db/#{DBNAME}-development.db"), 
+  production: ConnectionAdapter.new("db/#{DBNAME}-production.db")
+  )

data/lib/templates/activerecord/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+ENV["ACTIVE_RECORD_ENV"] = "test"
+
+require_relative '../config/environment'
+
+RSpec.configure do |config|
+
+  config.before do
+    run_rake_task('db:migrate')
+  end
+end
+
+def run_rake_task(task)
+  RAKE_APP[task].invoke
+  if task == 'db:migrate'
+    RAKE_APP[task].reenable
+  end
+end
+
+def __
+  raise "Replace __ with test code."
+end

data/lib/templates/command-line/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/lib/templates/command-line/README.md

@@ -0,0 +1,5 @@
+---
+tags: 
+languages: 
+resources: 
+---