slate-installer 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzA4YjRlZTE3OTUyMGVlZjQ0ZWI2NjM0M2YyYjRlYWRlZTk3MTJjZg==
+  data.tar.gz: !binary |-
+    ZmEyZGI5NjcyM2RmMTllZjcxMzc1YzFjMWRlMGQyNmQ2OTgyNzJhMA==
+SHA512:
+  metadata.gz: !binary |-
+    NmRjMGY5NWYyMDJmZTJjNGM1ODMxZjJkZjg1ZDZhOTU4MDI3OTcyYzAzYjg4
+    N2Q1NGQ0NTNhM2M0ZGRlMDU3MzA3NTRmNDgyYTNkMGNjMDZjMDM0YmY4OGY2
+    MTVhY2ZhYzhjMTdiNGM4MDk4NjY1NzhiNTljOTVhZGIyNDU0ZDQ=
+  data.tar.gz: !binary |-
+    MDEwYjU0MWY0ODcyOGZjNTM4MDMzYmRlM2ZhZjI1MDExNDdlZmNkMDk2NDg0
+    NDM2N2YyYTE3ODc3ODY1N2M2OGI1YTFmNDc4YWViZjhkNzhiYmM2MDBhNmY1
+    MDZmNzI5YWNkOWRmZTUxNDFkZDFjYjBmZjdkMjcwNTM1ZGJmYjM=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm: 2.3.1
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: hL0h5W084SQgCMufhUYzzrLq0krzt+C5WgmobbB81f684XJ+2FG6SvouPSzrAKLjgv/Ksk3G+oqr6kvTSV7L20+le+dpkE7c1lXDuwzs8Kd/VVr1ZJxDOu5Mn0NcVGvEdl+qKT8GLrz1KskK7QQdld0e+k3F7U+7ixtd2uz9GSZfBBjFSYTc38aa9O9EM0DqzYp717oDxZKChlB5p5G6btawpBGpdjayU+h/x8Pk2XIFTlrZ4lGml5Qku01mjFeBZ2noRl6EYLK1q64bKJ8H1cCyqTVNr2cm9Z+YCi9Wp35SZESDRkNhg6vDOB4zPYzaJZSMpTzjTtyKoI2nroOUjsd0GEAupoumeWqjQSWxtxSTdzHM6OVJe3FI0YPSYk7eVpZbYjvzvHXjJPHgakOIGbrV60+DLaBF07vD4JazoxgG8EKXwJHIF1XvCdXQSns0VcCetaL4wmQvB0pKkf0eWVwhfvAm511i9oHKUhzslIUx2b9vBwi+r3Ed5mLRX21Pr4suVDWpWmaqQL2+8iFMbz0D2/kRFisY8Ym+HoPeaX/yUWsblG311ozQpcqmqWZk7YSUnA4NBWFMJY40G11DWDRNI/8UJrTjyLDGEB/gnIQe8OFDQuYW8iTH8C1VjCCR61WwW0YR9q3hhG4mvx/qM5TwWnrF7xC0uOIlrxOSVlE=
+  gem: slate-installer
+  on:
+    tags: true
+    repo: kjg/slate-installer

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kevin@glowacz.info. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kevin Glowacz
+
+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,68 @@
+# Slate::Installer
+
+[![Build Status](https://travis-ci.org/kjg/slate-installer.svg?branch=master)](https://travis-ci.org/kjg/slate-installer)
+
+Slate::Installer is a utility to install (or update) [Slate](https://github.com/lord/slate) into the docs folder of your project. You then can then add and modify the slate docs right within the same repo as the code it is documenting.
+
+Running the installer on an existing slate installation will pull down the latest slate source and allow you to pick and choose which files to replace so you easily get updates without clobbering your modifications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'slate-installer'
+```
+
+And then execute:
+
+```shell
+  $ bundle
+```
+
+Or install it yourself as:
+
+```shell
+  $ gem install slate-installer
+```
+
+## Usage
+
+Slate::Installer is powered by Thor, so you can run
+
+```shell
+$ slate-installer
+
+Slate Installer commands:
+  slate-installer help [COMMAND]  # Describe available commands or one specific command
+  slate-installer install         # creates a docs folder and installs latest slate into it
+
+Runtime options:
+  -f, [--force]                    # Overwrite files that already exist
+  -p, [--pretend], [--no-pretend]  # Run but do not make any changes
+  -q, [--quiet], [--no-quiet]      # Suppress status output
+  -s, [--skip], [--no-skip]        # Skip files that already exist
+```
+
+to see all the available options.
+
+To install slate into your docs folder run
+
+```shell
+  $ slate-installer install
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kjg/slate-installer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slate/installer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/slate-installer

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+git_path = File.expand_path("../../.git", __FILE__)
+
+if File.exist?(git_path)
+  lib_path = File.expand_path("../../lib", __FILE__)
+  $:.unshift(lib_path)
+end
+
+require "slate/installer/cli"
+Slate::Installer::Cli.start

data/lib/slate/installer/cli.rb

@@ -0,0 +1,29 @@
+require 'thor'
+require 'tmpdir'
+require 'pathname'
+require 'open3'
+
+module Slate
+  module Installer
+    class Cli < Thor
+      package_name "Slate Installer"
+      include Thor::Actions
+
+      self.add_runtime_options!
+
+      def self.source_paths
+        [Dir.tmpdir]
+      end
+
+      desc "install", "creates a docs folder and installs latest slate into it"
+      def install
+        Dir.mktmpdir("slate-src-") do |tmpdir|
+          output, _status = Open3.capture2e("git", "clone", "--depth", "1", "--progress", "https://github.com/lord/slate.git",  tmpdir)
+          puts output
+          directory Pathname.new(tmpdir).basename, "docs", \
+            mode: :preserve, recursive: true, exclude_pattern: /(?:\.git(?:hub)?\/)|(?:\.travis)/
+        end
+      end
+    end
+  end
+end

data/lib/slate/installer/version.rb

@@ -0,0 +1,5 @@
+module Slate
+  module Installer
+    VERSION = "1.0.0"
+  end
+end

data/lib/slate/installer.rb

@@ -0,0 +1,7 @@
+require "slate/installer/version"
+
+module Slate
+  module Installer
+    # Your code goes here...
+  end
+end

data/slate-installer.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slate/installer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slate-installer"
+  spec.version       = Slate::Installer::VERSION
+  spec.authors       = ["Kevin Glowacz"]
+  spec.email         = ["kevin@glowacz.info"]
+
+  spec.summary       = "Easily slate powered docs to your app"
+  spec.description   = "This provides a utility to add and update your docs " \
+                       "folder with the latest slate source"
+  spec.homepage      = "https://github.com/kjg/slate-installer"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.0.0"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'thor', '~> 0.19'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: slate-installer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kevin Glowacz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This provides a utility to add and update your docs folder with the latest
+  slate source
+email:
+- kevin@glowacz.info
+executables:
+- slate-installer
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/slate-installer
+- lib/slate/installer.rb
+- lib/slate/installer/cli.rb
+- lib/slate/installer/version.rb
+- slate-installer.gemspec
+homepage: https://github.com/kjg/slate-installer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Easily slate powered docs to your app
+test_files: []