sign 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5eb22ecc6ce95485daef7ca63612f5f1cbe59d9b
-  data.tar.gz: 5115c457f8a0010eddd86685f06e94e43a009d2f
+  metadata.gz: 6c1bff5b097d5ae5b177e79f40e00ec1fa6cd42a
+  data.tar.gz: 7339e34897141d28bda6ec9e31eee1911d1766cf
 SHA512:
-  metadata.gz: '093582cfa72d300fe3fceab2950c14e6d73168d5dc7a5dd90ce8d6f30529c47801ee88e1c637a699403a8b863e115ea766a40d2c797de3471dbd3377308546a3'
-  data.tar.gz: 3f82bd1878955aa6a8ecfcd14bba359749825f87db90c35612726060215f2341c628cb12f0ec4233dc648122eb363b8af35a77f2323dbbafde96d944f582c9c8
+  metadata.gz: 331a0a5f1cd6872a5940d0a31a2fe5066e28891e4081754a562db855d86f4fab36224545d4390081351320306ac56b02c0673aa42c959e7c01b39b938ae2145f
+  data.tar.gz: b3f7504cfa5d16ffda2562a6171fc36b6caa6e4125d971a59fe93ee4ee28f893aeabb7b0926c5d3859350cbe6a06f8d811a596aaacc5fb342f40b3d4271951a9

data/.gitignore

@@ -42,11 +42,13 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.rspec_status
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
 notes.md
+.DS_STORE

data/.travis.yml

@@ -1,5 +1,7 @@
 sudo: false
 language: ruby
 rvm:
+  - 2.2.8
+  - 2.3.5
   - 2.4.2
-before_install: gem install bundler -v 1.15.4
+before_install: gem install bundler

data/CHANGELOG.md

@@ -4,13 +4,44 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2017-11-02
+### Added
+- More licenses.
+### Changed
+- Sign will check if a license file exists before creating/overwriting.
+- Alias for options and flags.
+- Overall refactor of code to improve code readability.
+
+## [1.0.0] - 2017-11-02
+### Changed
+- Update README.
 
-## [0.2.0] - 2017-10-26
+
+## [0.6.0] - 2017-11-02
 ### Added
-- Command prompt using `gem`.
-- Display help information using `-h` or `--help` flag.
+- Licenses assemble! Look at the entire list with `sign --list`.
+
+
+## [0.5.0] - 2017-11-01
+### Added
+- Runner is able to fetch and generate a license.
+- Runner saves generated licenses into current project directory.
+- Option to display version number.
+- Tests for `Sign::Fetcher`.
+- Tests for `Sign::Generator`.
+### Changed
+- Add tests for `Sign::Runner#create_license`.
+
+
+## [0.2.0] - 2017-10-28
+### Added
+- Cli prompt in `runner.rb`.
+- Return help information using `--help`.
+- Tests for cli initialization and help information.
+- Create `TestHelper` module to capture stdout and stderr.
 ### Changed
 - Rename project `lc -> sign`.
 
+
 ## [0.1.0] - 2017-10-25
 - Create initial project structure.

data/Gemfile

@@ -1,6 +1,3 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in sign.gemspec
 gemspec

data/README.md

@@ -1,19 +1,22 @@
 # Sign
 
-Generate a license for your project in a matter of seconds.
-
-
 [![Gem Version](https://badge.fury.io/rb/sign.svg)](https://badge.fury.io/rb/sign)
-[![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
+[![Travis CI](https://img.shields.io/travis/evanscloud/sign.svg)](https://travis-ci.org/evanscloud/sign)
 [![MIT License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://opensource.org/licenses/MIT)
 
 **tl;dr**: Generate a license for your project in less than 10 seconds.
 
-When you need a license for your project, you have to: search for one, copy it, create a text file, and then paste it in (let's not forget changing the year and name too). This process takes about 1-2 mins  Well no more! Signer generates a license for you in less than 10 seconds. No need for an internet connection either!
+When you need a license for your project, you have to: 
 
-## Installation
+1. Search for one on the web.
+2. Copy it.
+3. Create a text file.
+4. Paste into text file.
+5. Ugh (don't forget to change name and year if it's not filled in).
 
-<!-- --- taken from readme doc automated--- -->
+This process can take about 1-2 minutes, precious time that you can be using for more important things. Well no more! Sign creates a license in your current project directory for you in less than 10 seconds. No need for an internet connection either!
+
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -21,31 +24,19 @@ Add this line to your application's Gemfile:
 gem 'sign'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install sign
-
-<!-- --- -->
+And then execute `bundle`. Or install using the command-line with:
 
 ```
-bundle exec rake install
-```
-
-```
-gem install
+$ gem install sign
 ```
 
 ## Usage
 
-There are a wide range of licenses available (enter `--help` to see the entire list). The format is `sign [options] <license name>`.
+There are a wide range of licenses available (enter `--list` to see the entire list). The format is `sign <license name>`.
 
 ### Examples
 
-To display the license:
+To create an MIT license:
 
 ```
 ```
@@ -57,6 +48,10 @@ To create a file and save a license in it:
 
 To
 
+## Updates
+
+Check [CHANGELOG](https://github.com/evanscloud/sign/blob/master/CHANGELOG.md) for all updates.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/sign

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/sign"
+
+Sign::Runner.new.start

data/lib/sign/fetcher.rb

@@ -0,0 +1,34 @@
+module Sign
+  class Fetcher
+    @@list = {}
+    
+    Dir["vendor/licenses/*.txt"].select do |file|
+      if File.file?(file)
+        name = File.basename(file, ".txt")
+        info = File.open(file){ |file| file.readline }.downcase.strip.gsub(/[^-a-z0-9\s]/, "")
+        @@list[name] = info
+      end
+    end
+    
+    def self.get_list
+      format = "%-16s %10s"
+      
+      @@list.each do |name, info| 
+        puts format % [name, info]
+      end
+    end
+    
+    def get(license)
+      if @@list.has_key?(license.downcase)
+        file_name = "#{license}.txt"
+        File.open("#{license_path}/#{file_name}")
+      else
+        raise ArgumentError, "#{license} is not available."
+      end
+    end
+    
+    def license_path
+      File.expand_path("../../vendor/licenses", __dir__)
+    end
+  end
+end

data/lib/sign/generator.rb

@@ -0,0 +1,61 @@
+require "Date"
+
+module Sign
+  class Generator
+    def make(license, name, year)
+      raise ArgumentError, "#{license} is not available." unless File.readable?(license)
+
+      license_template = File.read(license)
+      name = get_name if name.nil?
+      year = get_year if year.nil?
+      
+      if placeholders_exist?(license_template)
+        modified_license = license_template.gsub("[AUTHOR]", name)
+        modified_license = modified_license.gsub("[YEAR]", year)
+      end
+      
+      create_new_file(modified_license)
+    end
+    
+    def placeholders_exist?(license_template)
+      placeholders = ["[YEAR]", "[AUTHOR]"]
+  
+      placeholders.any? { |placeholder| license_template.include?(placeholder) }
+    end
+    
+    def create_new_file(modified_license)
+      new_file = File.new("LICENSE", "w")
+      new_file.puts(modified_license)
+      new_file.close
+      puts "License created \033[91m<3\033[0m"
+    end
+    
+    def get_name
+      if gitconfig_exist?
+        find_name
+      else
+        return ""
+      end
+    end
+    
+    def find_name
+      File.foreach("#{gitconfig_path}/.gitconfig").detect do |line| 
+        if line.match("\tname")
+          return line.scan(/= (.*)/).last[0]
+        end
+      end
+    end
+    
+    def get_year
+      return Date.today.year.to_s
+    end
+    
+    def gitconfig_exist?
+      File.exist?("#{gitconfig_path}/.gitconfig")
+    end
+    
+    def gitconfig_path
+      File.expand_path("~/", __dir__)
+    end
+  end
+end

data/lib/sign/runner.rb

@@ -0,0 +1,59 @@
+module Sign
+  class Runner
+    def start
+      argv = ARGV.clone
+      argv << "--help" if argv.empty?
+
+      case argv[0]
+      when "--help"
+        display_help
+      when "--version"
+        display_version
+      when "--list"
+        display_list
+      else
+        create_license(argv)
+      end
+    end
+
+    def display_help
+      puts ""
+      puts "  Generate a license for your project in a matter of seconds."
+      puts ""
+      puts "  Usage:"
+      puts ""
+      puts "      sign [option] <license>"
+      puts ""
+      puts "  Options:"
+      puts ""
+      puts "      --version   display version number"
+      puts "      --help      display help information"
+      puts "      --list      display list of licenses"
+      puts ""
+    end
+    
+    def display_list
+      puts ""
+      puts "List of available licenses:"
+      puts ""
+      Sign::Fetcher.get_list
+      puts ""
+    end
+    
+    def display_version
+      puts "Sign v#{Sign::VERSION}"
+    end
+    
+    def create_license(argv)
+      license = Sign::Fetcher.new.get(argv[0])
+      name = !!argv[1] ? parse_argument(argv[1]) : nil
+      year = !!argv[2] ? parse_argument(argv[2]) : nil
+      
+      Sign::Generator.new.make(license, name, year)
+    end
+    
+    def parse_argument(arg)
+      arg.scan(/=(.*)/).last[0]
+    end
+  end
+end

data/lib/sign/version.rb

@@ -1,3 +1,3 @@
 module Sign
-  VERSION = "0.1.0"
+  VERSION = "0.6.0"
 end

data/lib/sign.rb

@@ -1,9 +1,4 @@
-require "sign/version"
-
-module Sign
-  class Greeting
-    def self.greet
-      puts "Hello, world"
-    end
-  end
-end
+require_relative "sign/version"
+require_relative "sign/runner"
+require_relative "sign/fetcher"
+require_relative "sign/generator"