learn-tool 0.0.16

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d759f8eb4d52c7c0a73d3eb067320d66341085777d1e22cef08c026fc0d02e0
+  data.tar.gz: 339ede530dbd6f1a4e1aa62a816a91f6bf40b697250582ce549c58cb82dae4d5
+SHA512:
+  metadata.gz: 1c31b985672fa05ea1ed8350103fd00fd536715c2336686ac490aee10cfb33425a9490d4927453182256518f47ea856505825a54309cdb96c128c61bad8cd8df
+  data.tar.gz: ab74b388effd6db8844f8c6ba89596e4e2fcea0cdafecf468ac98c9952079522d06114d693c8f29fcca7b7573120eadb1cdb214b7f3272c5ad37af9d75eb1c2a

data/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to Learn.co Curriculum
+
+We're really excited that you're about to contribute to the
+[open curriculum](https://learn.co/content-license) on
+[Learn.co](https://learn.co). If this is your first time contributing, please
+continue reading to learn how to make the most meaningful and useful impact
+possible.
+
+## Raising an Issue to Encourage a Contribution
+
+If you notice a problem with the curriculum that you believe needs improvement
+but you're unable to make the change yourself, you should raise a Github issue
+containing a clear description of the problem. Include relevant snippets of the
+content and/or screenshots if applicable. Curriculum owners regularly review
+issue lists and your issue will be prioritized and addressed as appropriate.
+
+## Submitting a Pull Request to Suggest an Improvement
+
+If you see an opportunity for improvement and can make the change yourself go
+ahead and use a typical git workflow to make it happen:
+
+* Fork this curriculum repository
+* Make the change on your fork, with descriptive commits in the standard format
+* Open a Pull Request against this repo
+
+A curriculum owner will review your change and approve or comment on it in due
+course.
+
+# Why Contribute?
+
+Curriculum on Learn is publicly and freely available under Learn's
+[Educational Content License](https://learn.co/content-license). By embracing an
+open-source contribution model, our goal is for the curriculum on Learn to
+become, in time, the best educational content the world has ever seen.
+
+We need help from the community of Learners to maintain and improve the
+educational content. Everything from fixing typos, to correcting out-dated
+information, to improving exposition, to adding better examples, to fixing
+tests—all contributions to making the curriculum more effective are welcome.

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+ruby "2.6.1"
+
+gem 'json'
+gem 'require_all'
+gem 'awesome_print'
+gem 'faraday'
+gem 'uri'
+
+# Specify your gem's dependencies in learn_create.gemspec

data/LICENSE.md

@@ -0,0 +1,23 @@
+# Learn.co Educational Content License
+
+Copyright (c) 2015 Flatiron School, Inc
+
+The Flatiron School, Inc. owns this Educational Content. However, the Flatiron
+School supports the development and availability of educational materials in the
+public domain. Therefore, the Flatiron School grants Users of the Flatiron
+Educational Content set forth in this repository certain rights to reuse, build
+upon and share such Educational Content subject to the terms of the Educational
+Content License set forth [here](http://learn.co/content-license)
+(http://learn.co/content-license). You must read carefully the terms and
+conditions contained in the Educational Content License as such terms govern
+access to and use of the Educational Content.  
+
+Flatiron School is willing to allow you access to and use of the Educational
+Content only on the condition that you accept all of the terms and conditions
+contained in the Educational Content License set forth
+[here](http://learn.co/content-license) (http://learn.co/content-license).  By
+accessing and/or using the Educational Content, you are agreeing to all of the
+terms and conditions contained in the Educational Content License.  If you do
+not agree to any or all of the terms of the Educational Content License, you are
+prohibited from accessing, reviewing or using in any way the Educational
+Content.

data/README.md

@@ -0,0 +1,98 @@
+# Learn Tool
+
+This gem is designed to aid in the creation, duplication and repair of Learn lessons.
+
+## Installation and Setup
+
+Before using `learn-tool`, you must install `hub`, GitHub's extended CLI API.
+
+```sh
+brew install hub
+```
+
+Once `hub` is installed, you'll need to get it configured before running
+`learn-tool`. The best way to do this is to use `hub` once to create a
+repository on learn-co-curriculum. In the shell:
+
+- Create a new, empty folder and `cd` into it
+- Run `git init` to initialize git
+- Run `hub create learn-co-curriculum/<whatever-name-you've-chosen>`
+  - You should be prompted to sign in to GitHub
+  - **Note:** If you have set up two-factor identification on GitHub, when
+    prompted for your password, you have two options:
+    - If Github SMS' you a one-time password, use it!
+    - Otherwise, instead of using your normal password, you
+      need to enter a Personal Access Token. You can create a token in your
+      GitHub settings page.
+- If everything works as expected you should now have an empty `learn-co-curriculum` repo.
+- Delete the repo, please. Everything should be set up now.
+
+Install the `learn-tool` gem:
+
+```sh
+gem install learn-tool
+```
+
+## Lesson Creation
+
+To create  a new repository, navigate to the folder where you'd like your
+repo to be duplicated locally and type:
+
+```sh
+learn-tool create
+```
+
+Follow the prompts to create a blank readme, code-along or lab repository. The
+repo will be created locally and pushed to GitHub. When finished, you can `cd`
+into the local folder or open it on github to start working. This command draws
+from a number of existing templates.
+
+- [Readme Template](https://github.com/learn-co-curriculum/readme-template)
+- [Ruby Lab Template](https://github.com/learn-co-curriculum/ruby-lab-template)
+- [JavaScript Lab Template](https://github.com/learn-co-curriculum/js-lab-template)
+- React Lab Template (to be linked)
+
+For other lesson types, start with a Readme.
+
+## Lesson Duplication
+
+To duplicate an existing repository, type:
+
+```sh
+learn-tool duplicate
+```
+
+This command will make an exact copy of another repository. For example, you
+could use this if you want to create a new Active Record lab and want to borrow
+the configuration of an existing lab.
+
+**Note**: if you have an idea on how improvement to an existing lesson, please
+consider creating a fork and submit a pull request on the **original lesson**
+rather than creating an altered duplicate.
+
+## Lesson Repair
+
+If you already have a repository or created one manually, it is important that
+certain files are present:
+
+- `.learn` - this file is required. In addition, this file must contain a
+  `languages` attribute. Not including this file or the required attributet will
+  cause deploy issues.
+- `LICENSE.md` - All educational materials used through the Learn platform
+  should include this file.
+- `CONTRIBUTING.md` - This file contains information on how to contribute to our
+  content.
+
+To quickly add or fix these files, type:
+
+```sh
+learn-tool repair
+```
+
+This command will replace or add the required files to the current repository.
+
+## Resources
+
+- [Hub][hub]
+
+[hub]: https://hub.github.com/hub.1.html

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/learn-tool

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'learn-tool'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = <<-EOBANNER
+
+    Learn-Tool
+    ====================
+    A tool for creating, cloning and repairing repositories. This tool has
+    three basic commands
+    
+    learn-tool create
+    learn-tool duplicate
+    learn-tool repair
+
+    When creating, you will need to provide a name of the repository you are
+    creating and choose from an existing template.
+
+    When duplicating, you will want the canonical name of a repository e.g.:
+    ruby-enumerables-enumerable-family-tree. You will also want to know the clone
+    name e.g snapshot-clone-enumerable-family-tree
+   
+  EOBANNER
+
+  opts.on("--create", "-c", "Create new repository"){ |v| options[:create] = true }
+  opts.on("--duplicate", "-d", "Clone from existing repository"){ |v| options[:duplicate] = true }
+  opts.on("--repair", "-r", "Fix current repository"){ |v| options[:repair] = true }
+end.parse!
+
+puts options
+
+if options[:create]
+    LearnTool.new("create")
+end
+
+if options[:duplicate]
+    LearnTool.new("duplicate")
+end
+
+if options[:repair]
+    LearnTool.new("repair")
+end
+
+

data/lib/learn-tool.rb

@@ -0,0 +1,238 @@
+require 'faraday'
+require 'uri'
+require 'open3'
+
+class LearnTool
+  GITHUB_ORG = 'https://api.github.com/repos/learn-co-curriculum/'
+  README_TEMPLATE = 'readme-template'
+  RUBY_LAB_TEMPLATE = 'ruby-lab-template'
+  JAVASCRIPT_LAB_TEMPLATE = 'js-lab-template'
+  REACT_LAB_TEMPLATE = 'react-lab-template'
+
+  def initialize(mode)
+    @ssh_configured  = check_ssh_config
+    puts mode
+    if mode == 'create'
+      create
+    end
+
+    if mode == 'duplicate'
+      duplicate
+    end
+
+    if mode == 'repair'
+      repair
+    end
+  end
+
+  def create
+    puts 'Note: You must have write access to the learn-co-curriculum org on GitHub to use this tool'
+    until name_new_repo do
+      puts 'Careful - rate limiting can occur'
+    end
+
+    choose_repo_template
+    create_new_repo
+    end_message
+  end
+
+  def choose_repo_template
+    puts 'Is the lesson you are creating a Readme? (Y/n)'
+    readme_input = gets.chomp.downcase
+    if readme_input == "n" || readme_input == "no" || readme_input == "N" || readme_input == "No"
+      language = choose_language
+      case language
+      when /^ru/
+        @old_repo_name = RUBY_LAB_TEMPLATE
+      when /^j/
+        @old_repo_name = JAVASCRIPT_LAB_TEMPLATE
+      when /^re/
+        @old_repo_name = REACT_LAB_TEMPLATE
+      else
+        @old_repo_name = README_TEMPLATE
+      end
+    else
+      @old_repo_name = README_TEMPLATE
+    end
+    @old_repo_name
+  end
+
+  def choose_language
+    language = ''
+    loop do
+      puts 'What lab template would you like to use? (Ruby/JavaScript/React)'
+      language = gets.chomp.downcase
+      break if language =~ /^(ru|j|re)/
+      puts 'Please enter Ruby, JavaScript or React, or at minimum, the first two letters:'
+      puts ''
+    end
+    language
+  end
+
+  def duplicate
+    puts 'Note: You must have write access to the learn-co-curriculum org on GitHub to use this tool'
+    loop do
+      puts 'What is the name of the repository you would like to copy? Paste exactly as is shown in the URL (i.e. advanced-hashes-hashketball)'
+      old_repo_name_input = gets.strip
+      if repo_exists(old_repo_name_input)
+        @old_repo_name = old_repo_name_input
+        puts ''
+        puts 'Old repository: ' + @old_repo_name
+        until name_new_repo do
+          puts 'Careful - rate limiting can occur'
+        end
+        
+        
+        create_new_repo
+        end_message
+        break
+      else
+        puts 'Provided repository name is not a valid learn-co-curriculum repository. Please try again. Careful - rate limiting can be triggered'
+      end
+    end
+  end
+
+  def name_new_repo
+    puts 'What is the name of the repository you would like to create?'
+    new_name = gets.strip.gsub(/\s+/, '-').downcase
+
+    if name_length_is_good(new_name)
+      if !repo_exists(new_name)
+        @new_repo_name = new_name
+      else
+        puts 'A repository with that name already exists. Please try again.'
+        return false
+      end
+    else
+      puts 'Repository names must be shorter than 100 characters'
+      return false
+    end
+    @new_repo_name
+  end
+
+  def create_new_repo
+    # 'cd' doesn't work the way it would in the shell, must be used before every command
+    puts 'Cloning old repository'
+    git_clone
+    # puts "Renaming old directory with new name: #{@new_repo_name}"
+    # rename_repo
+    puts ''
+    puts 'Creating new remote learn-co-curriculum repository'
+    git_create_and_set_new_origin
+    puts ''
+    puts 'Setting new git remote based on SSH settings'
+    git_set_remote
+    puts ''
+    puts 'Pushing all old-remote branches to new remote'
+    git_push
+  end
+
+  def end_message
+    puts ''
+    puts 'To access local folder, change directory into ' + @new_repo_name + '/'
+    puts "Repository available at #{GITHUB_ORG}" + @new_repo_name
+  end
+
+  private
+
+  def git_clone
+    cmd = "git clone https://github.com/learn-co-curriculum/#{@old_repo_name} #{@new_repo_name}"
+    puts cmd
+    `#{cmd}`
+  end
+
+  def git_create_and_set_new_origin
+    # Creates repo **and** assigns new remote to 'origin' shortname
+    cmd = cd_into_and("hub create learn-co-curriculum/#{@new_repo_name}")
+    puts cmd
+    `#{cmd}`
+  end
+
+  def git_set_remote
+    remote = check_ssh_config ? "git@github.com:learn-co-curriculum/#{@new_repo_name}.git" : "https://github.com/learn-co-curriculum/#{@new_repo_name}"
+    cmd = cd_into_and("git remote set-url origin #{remote}")
+    puts cmd
+    `#{cmd}`
+  end
+
+  def git_push
+    # Copy `master`, attempt to copy `solution`, but if it's not there, no complaints
+    cmds = [
+      %q|git push origin 'refs/remotes/origin/master:refs/heads/master' > /dev/null 2>&1|,
+      %q|git push origin 'refs/remotes/origin/solution:refs/heads/solution' > /dev/null 2>&1|
+    ]
+    cmds.each { |cmd| `#{cd_into_and(cmd)}` }
+  end
+
+  def repo_exists(repo_name)
+    url = GITHUB_ORG + repo_name
+    encoded_url = URI.encode(url).slice(0, url.length)
+    check_existing = Faraday.get URI.parse(encoded_url)
+    !check_existing.body.include? '"Not Found"'
+  end
+
+  def cd_into_and(command)
+    "cd #{@new_repo_name} && #{command}"
+  end
+
+  def create_support_file(name_of_file)
+    # copies a template folder from the learn_create gem to a subfolder of the current directory
+    gem_template_location = File.dirname(__FILE__)
+    template_path = File.expand_path(gem_template_location) + "/support_files/#{name_of_file.upcase}"
+    cmd = "cp #{template_path} #{Dir.pwd}"
+    `#{cmd}`
+  end
+
+  def create_dot_learn_file
+    `
+cat > .learn <<EOL
+languages:
+- none
+    `
+  end
+  
+#   def create_dot_gitignore_file
+#     `
+# cat > .gitignore <<EOL
+# .DS_Store
+# logs
+# *.log
+# npm-debug.log*
+# pids
+# *.pid
+# *.seed
+# lib-cov
+# build/Release
+# node_modules
+# jspm_packages
+# .npm
+# .node_repl_history
+# .results.json
+# /.bundle
+# /db/*.sqlite3
+# /db/*.sqlite3-journal
+# /log/*
+# !/log/.keep
+# /tmp
+#     `
+#   end
+
+  
+
+  def repair
+    create_dot_learn_file
+    create_support_file("LICENSE.md")
+    create_support_file("CONTRIBUTING.md")
+  end
+
+  def name_length_is_good(name)
+    name.length < 100
+  end
+
+  def check_ssh_config
+    result = Open3.capture2e('ssh -T git@github.com').first
+    result.include?("You've successfully authenticated")
+  end
+
+  
+end

data/lib/support_files/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to Learn.co Curriculum
+
+We're really excited that you're about to contribute to the
+[open curriculum](https://learn.co/content-license) on
+[Learn.co](https://learn.co). If this is your first time contributing, please
+continue reading to learn how to make the most meaningful and useful impact
+possible.
+
+## Raising an Issue to Encourage a Contribution
+
+If you notice a problem with the curriculum that you believe needs improvement
+but you're unable to make the change yourself, you should raise a Github issue
+containing a clear description of the problem. Include relevant snippets of the
+content and/or screenshots if applicable. Curriculum owners regularly review
+issue lists and your issue will be prioritized and addressed as appropriate.
+
+## Submitting a Pull Request to Suggest an Improvement
+
+If you see an opportunity for improvement and can make the change yourself go
+ahead and use a typical git workflow to make it happen:
+
+* Fork this curriculum repository
+* Make the change on your fork, with descriptive commits in the standard format
+* Open a Pull Request against this repo
+
+A curriculum owner will review your change and approve or comment on it in due
+course.
+
+# Why Contribute?
+
+Curriculum on Learn is publicly and freely available under Learn's
+[Educational Content License](https://learn.co/content-license). By embracing an
+open-source contribution model, our goal is for the curriculum on Learn to
+become, in time, the best educational content the world has ever seen.
+
+We need help from the community of Learners to maintain and improve the
+educational content. Everything from fixing typos, to correcting out-dated
+information, to improving exposition, to adding better examples, to fixing
+tests—all contributions to making the curriculum more effective are welcome.

data/lib/support_files/LICENSE.md

@@ -0,0 +1,23 @@
+# Learn.co Educational Content License
+
+Copyright (c) 2015 Flatiron School, Inc
+
+The Flatiron School, Inc. owns this Educational Content. However, the Flatiron
+School supports the development and availability of educational materials in the
+public domain. Therefore, the Flatiron School grants Users of the Flatiron
+Educational Content set forth in this repository certain rights to reuse, build
+upon and share such Educational Content subject to the terms of the Educational
+Content License set forth [here](http://learn.co/content-license)
+(http://learn.co/content-license). You must read carefully the terms and
+conditions contained in the Educational Content License as such terms govern
+access to and use of the Educational Content.  
+
+Flatiron School is willing to allow you access to and use of the Educational
+Content only on the condition that you accept all of the terms and conditions
+contained in the Educational Content License set forth
+[here](http://learn.co/content-license) (http://learn.co/content-license).  By
+accessing and/or using the Educational Content, you are agreeing to all of the
+terms and conditions contained in the Educational Content License.  If you do
+not agree to any or all of the terms of the Educational Content License, you are
+prohibited from accessing, reviewing or using in any way the Educational
+Content.

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: learn-tool
+version: !ruby/object:Gem::Version
+  version: 0.0.16
+platform: ruby
+authors:
+- flatironschool
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: 
+email: maxwell@flatironschool.com
+executables:
+- learn-tool
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/learn-tool
+- lib/learn-tool.rb
+- lib/support_files/CONTRIBUTING.md
+- lib/support_files/LICENSE.md
+homepage: https://github.com/learn-co-curriculum/learn-tool
+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: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: learn-tool is a tool for creating, duplicating and repairing learn.co lessons
+  on GitHub
+test_files: []