skippy 0.2.0.a → 0.3.0.a

data/.vscode/settings.json

@@ -1,5 +1,44 @@
 // Place your settings in this file to overwrite default and user settings.
 {
-  "editor.wrappingColumn": 80,
-  "files.insertFinalNewline": true
+  "editor.wordWrap": "off",
+  "editor.rulers": [
+    80
+  ],
+
+
+  "files.insertFinalNewline": true,
+
+  "ruby.lint": {
+    "rubocop": true
+  },
+
+  "[markdown]": {
+    "editor.wordWrap": "bounded",
+    "editor.wordWrapColumn": 80
+  },
+
+  "todohighlight.keywordsPattern": "(TODO|FIXME|KLUDGE)(\\([^)]+\\))?:",
+  "todohighlight.include": [
+    "**/*.rb",
+    "**/*.md",
+    "**/*.html",
+    "**/*.js",
+    "**/*.css"
+  ],
+  "todohighlight.exclude": [
+    "**/node_modules/**",
+    "**/bower_components/**",
+    "**/dist/**",
+    "**/build/**",
+    "**/.vscode/**",
+    "**/.github/**",
+    "**/_output/**",
+    "**/*.min.*",
+    "**/*.map",
+    "**/.next/**",
+    "fixtures/**",
+    "pkg/**",
+    "tmp/**",
+    "vendor/**",
+  ]
 }

data/.vscode/tasks.json

@@ -1,16 +1,16 @@
-{
-  // See https://go.microsoft.com/fwlink/?LinkId=733558
-  // for the documentation about the tasks.json format
-  "version": "0.1.0",
-  "command": "bundle",
-  "isShellCommand": true,
-  "showOutput": "always",
-  "echoCommand": true,
-  "args": ["exec", "rake"],
-  "tasks": [{
-      "taskName": "test",
-      "args": ["TEST=${relativeFile}"],
-      "isTestCommand": true,
-      "isBuildCommand": true
-   }]
-}
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "0.1.0",
+  "command": "bundle",
+  "isShellCommand": true,
+  "showOutput": "always",
+  "echoCommand": true,
+  "args": ["exec", "rake"],
+  "tasks": [{
+      "taskName": "test",
+      "args": ["TEST=${relativeFile}"],
+      "isTestCommand": true,
+      "isBuildCommand": true
+   }]
+}

data/Gemfile

@@ -4,6 +4,15 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'aruba', :git => 'https://github.com/daynix/aruba.git', :branch => 'd-win-fix'
-  #gem 'aruba', :github => 'daynix/aruba', :branch => 'd-win-fix'
+  # Original fork with bug-fix. Appear to be gone now.
+  # gem 'aruba', git: 'https://github.com/daynix/aruba.git', branch: 'd-win-fix'
+  # Backup fork of the bug fix:
+  gem 'aruba', git: 'https://github.com/thomthom/aruba.git',
+               branch: 'd-win-fix'
+  # TODO: This might be a newer fix:
+  # gem 'aruba', git: 'https://github.com/rbld/aruba.git',
+  #              branch: 'aruba-win-fix'
+  gem 'pry'
+  gem 'rubocop', '~> 0.51.0', require: false
+  gem 'webmock', '~> 3.1'
 end

data/README.md

@@ -4,28 +4,39 @@
 
 Skippy is a Command Line Interface which aims to automate common developer tasks for SketchUp Ruby extension development.
 
+![](https://github.com/thomthom/skippy/wiki/images/skippy-cli.gif)
+
 It is currently in very early stage of development so many things are incomplete. Feedback and contributions are welcome.
 
 Some of the main goals are:
 
-* Automate common tasks
-  * Packaging the extension
-  * Running build scripts
-* Easy interface to add per-project custom commands/tasks
-* Quick initialization of new project with templates
-* Library dependency management
-  * Pull in third-party modules into extension namespace
-  * Add/Remove/Update dependencies
+- [x] Quick initialization of new project with templates
+  - [ ] Add/Remove/Update user templates
+- [ ] Automate common tasks
+  - [ ] Packaging the extension
+  - [ ] Start SketchUp in debug mode
+- [x] Easy interface to add per-project custom commands/tasks
+- [x] Library dependency management
+  - [x] Pull in third-party modules into extension namespace
+  - [x] Add/Remove/Update dependencies
+
+## Requirements
+
+Your system will need a version of Ruby 2.0 or newer installed.
+
+macOS have a system version of Ruby already installed. If you need/want a different version you can for instance use [RVM](https://rvm.io/).
+
+For Windows the easiest way to get Ruby running is using the [Ruby Installer for Windows](https://rubyinstaller.org/).
 
 ## Installation
 
-    $ gem install skippy
+```bash
+gem install skippy
+```
 
 ## Usage
 
-TODO: Write more detailed usage instructions here.
-
-Install the gem on your system, afterwards the `skippy` command should become available.
+After installing the gem on your system, the `skippy` command should become available.
 
 ### Quick-Reference
 
@@ -33,11 +44,35 @@ Type `skippy` to list available commands.
 
 Type `skippy help [COMMAND]` for more information on how to use each command.
 
-Use `skippy new` to create a new project in the current folder.
+Use `skippy new NAMESPACE` to create a new project in the current folder.
 
 You can add custom per-project commands to a `skippy` folder in your project. Look at `skippy/example.rb` for an example of a simple custom command.
 
-### Power of Thor
+### Project Setup
+
+Create a new Skippy powered project by using the `skippy new` command in the project's root directory. Provide Skippy with the extension namespace:
+
+```bash
+skippy new Example::HelloWorld
+```
+
+Skippy will then scaffold the bare minimum for a SketchUp extension.
+
+Currently Skippy assumes that the source for the extension is located under a directory named `src`.
+
+![](https://github.com/thomthom/skippy/wiki/images/skippy-project.gif)
+
+#### Project Templates
+
+TODO: ...
+
+### Custom Project Commands
+
+In addition to scaffold the extension source code Skippy also creates a directory named `skippy` in the project root. Here it is possible to add custom Skippy commands to aid your project development. For instance running build scripts and other task automations.
+
+Look at the default [`skippy/example.rb`](app/resources/commands/example.rb).
+
+#### Power of Thor
 
 Skippy is built on [Thor](https://github.com/erikhuda/thor). Refer to [Thor's Website](http://whatisthor.com/) and [documentation](http://www.rubydoc.info/github/wycats/thor/index) for details on creating commands.
 
@@ -46,12 +81,156 @@ When creating Skippy command use the following replacements:
 * Instead of class `Thor`, use `Skippy::Command`
 * Instead of class `Thor::Group`, use `Skippy::Command::Group`
 
+### Installing Libraries
+
+Skippy offer a simple library dependency system. It can install a third party library into project workspace where by its various modules can be integrated into your extension project.
+
+The installed library is cached into `.skippy` directory. Don't check this into version control.
+
+When you check out an existing Skippy Project from source control use `skippy install` to install the required dependencies.
+
+#### Installing from Git Repositories
+
+```bash
+skippy lib:install https://github.com/thomthom/tt-lib.git
+```
+
+#### Installing from Git shorthand.
+
+```bash
+skippy lib:install thomthom/tt-lib
+```
+
+In the above example Skippy will look for the library `tt-lib` under the username `thomthom` from either [bitbucket.org](https://bitbucket.org/) or [github.com](https://github.com/)
+
+The sources can be altered per project by modifying `sources` in `skippy.json`:
+
+```
+  "sources": [
+    "github.com",
+    "bitbucket.org"
+  ],
+```
+
+Note that currently all source will be prefixed `https://` and post-fixed with the provided short-name. E.g., `thomthom/tt-lib` will resolve to `http://github.com/thomthom/tt-lib.git` and `http://bitbucket.org/thomthom/tt-lib.git` as `skippy` searches for matching sources.
+
+#### Installing from Local Directory
+
+```bash
+skippy lib:install ~/source/my-lib
+```
+
+It is also possible to install from a local directory. Pass in the path to the directory that contains the `skippy.json` of the library.
+
+![](https://github.com/thomthom/skippy/wiki/images/skippy-install-library.gif)
+
+### Using Modules
+
+Once a library is installed its modules can be used within the extension project. List the names of the available modules using `skippy lib:list`.
+
+Once you know the name you can instruct Skippy to use it:
+
+```bash
+skippy lib:use tt-lib/gl
+```
+
+This will copy the module from the `.skippy` directory and into `src/<ExtensionName>/vendor/<LibraryName>`. At the same time the outer namespace in the source code is changed to match your project's namespace.
+
+![](https://github.com/thomthom/skippy/wiki/images/skippy-use-module.gif)
+
+### Removing Modules
+
+A library module can be removed by using `skippy lib:remove`:
+
+```bash
+skippy lib:remove tt-lib/gl
+```
+
+This removes the files for that module from the `vendor` directory.
+
+![](https://github.com/thomthom/skippy/wiki/images/skippy-remove-module.gif)
+
+### Uninstalling Libraries
+
+Libraries can be completely removed from a project using `skippy lib::uninstall`:
+
+```bash
+skippy lib:uninstall tt-lib
+```
+
+This will remove all the library's modules in the `vendor` directory as well as removing the cached library in `.skippy`.
+
+![](https://github.com/thomthom/skippy/wiki/images/skippy-uninstall-library.gif)
+
+### Anatomy of a Skippy Library
+
+Below is an example of a simple Skippy Library:
+
+```
+example-library/
+├── modules/
+│   ├── hello/
+│   │   ├── extra.html
+│   │   └── extra.rb
+│   ├── hello.rb
+│   └── world.rb
+└── skippy.json
+```
+
+Each `.rb` under the `modules` directory is a Skippy Module. In this example the library contains the modules `hello` and `world`.
+
+Each Skippy Module can have a support directories where additional source code or assets can be organized. This support directory must match the filename of the module. In the example above this is illustrated by the Ruby file `modules/hello.rb` along with directory `modules/hello`.
+
+`skippy.json` contains meta data which is required to identify the library:
+
+```json
+{
+  "library": true,
+  "name": "my-lib",
+  "version": "1.0.0"
+}
+```
+
+The `name` value from `skippy.json` is the name that the users will use to refer to the library via `skippy`.
+
+If distributing the library via Git, the `version` value should match the tag from source control.
+
+A library can contain additional files or directories, for instance tests. They will simply be ignored by `skippy`.
+
+For more examples, refer to:
+* [github.com/thomthom/tt-lib](https://github.com/thomthom/tt-lib)
+* [github.com/thomthom/skippy-test-lib](https://github.com/thomthom/skippy-test-lib)
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repository, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+If there are problems installing dependencies try installing them locally and see if that works: `bundle install --path vendor/bundle`
 
 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).
 
+### Reminders
+
+Run individual tests: `bundle exec rake test TEST=test/library_source.rb`
+
+Run individual cucumber features: `bundle exec cucumber features/library.feature`
+
+## FAQ
+
+### SSL Errors?
+
+https://github.com/oneclick/rubyinstaller/issues/324#issuecomment-221383285
+
+> Download newest certs (cacert.pem) from here
+>
+> https://curl.haxx.se/docs/caextract.html
+>
+> Set environment variable to the full path location of the downloaded file. Eg:
+>
+>     set SSL_CERT_FILE=C:\somewhere\cacert.pem
+>
+> To make it permanent, set `SSL_CERT_FILE` in "Advanced System Settings"
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/thomthom/skippy.

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/app/boot.rb

@@ -24,7 +24,7 @@ begin
   require 'thor/runner'
   # This is also needed to be set in order for Thor's utilities to output
   # command names correctly.
-  $thor_runner = true
+  $thor_runner = true # rubocop:disable Style/GlobalVars
 ensure
   $VERBOSE = original_verbose
 end

data/app/commands/install.rb

@@ -0,0 +1,41 @@
+require 'json'
+
+require 'skippy/app'
+require 'skippy/group'
+require 'skippy/project'
+
+class Install < Skippy::Command::Group
+
+  attr_reader :project
+
+  def initialize_project
+    @project = Skippy::Project.current_or_fail
+  end
+
+  def installing_libraries
+    say ''
+    say 'Installing libraries...'
+    say ''
+    project.config.get(:libraries, []).each { |library|
+      say 'Missing library version', :red if library[:version].nil?
+      say 'Missing library source', :red if library[:source].nil?
+      next if library[:version].nil? || library[:source].nil?
+
+      options = {
+        requirement: library[:version]
+      }
+      options[:branch] = library[:branch] unless library[:branch].nil?
+      lib = project.libraries.install(library[:source], options)
+
+      unless lib.version == library[:version]
+        say "Expected version #{library[:version]}, got #{lib.version}", :red
+      end
+
+      say "Installed library: #{lib.name} (#{lib.version})", :green
+      say lib.path
+    }
+    # Don't save project - as all that is being done here is installing missing
+    # library cache into the .skippy directory.
+  end
+
+end

data/app/commands/lib.rb

@@ -18,7 +18,7 @@ class Lib < Skippy::Command
       say 'Installed libraries:', :yellow
       libraries.each { |library|
         say
-        say "#{library.title} (#{library.version})", [:bold, :yellow]
+        say "#{library.name} (#{library.version})", [:bold, :yellow]
         library.modules.each { |lib_module|
           lib_info = "  #{lib_module}"
           lib_info << ' (installed)' if project.modules.installed?(lib_module)
@@ -29,18 +29,58 @@ class Lib < Skippy::Command
   end
   default_command(:list)
 
+  method_option :version,
+    aliases: ['-v'],
+    type: :string
+  method_option :branch,
+    aliases: ['-b'],
+    type: :string
   desc 'install SOURCE', 'Install a new library'
   def install(source)
     project = Skippy::Project.current_or_fail
-    library = project.libraries.install(source)
+    libraries = project.libraries
+    library = libraries.install(source, install_options(options)) { |type, message|
+      color = type == :warning ? :red : :yellow
+      say message, color
+    }
+    project.save
     say "Installed library: #{library.name} (#{library.version})"
   end
 
+  desc 'uninstall LIBRARY', 'Uninstall a library'
+  def uninstall(library_name)
+    project = Skippy::Project.current_or_fail
+    library = project.libraries.uninstall(library_name)
+    project.save
+    say "Uninstalled library: #{library.name} (#{library.version})"
+  end
+
   desc 'use MODULE', 'Use a library module'
   def use(module_path)
     project = Skippy::Project.current_or_fail
     lib_module = project.modules.use(module_path)
+    project.save
     say "Using module: #{lib_module}"
   end
 
+  desc 'remove MODULE', 'Remove a library module'
+  def remove(module_path)
+    project = Skippy::Project.current_or_fail
+    lib_module = project.modules.remove(module_path)
+    project.save
+    say "Removed module: #{lib_module}"
+  end
+
+  private
+
+  def install_options(cli_options)
+    options = cli_options.map { |k, v| [k.to_sym, v] }.to_h
+    # The CLI options "version" is internally a "requirement".
+    if options.key?(:version)
+      options[:requirement] = options[:version]
+      options.delete(:version)
+    end
+    options
+  end
+
 end