skippy 0.2.0.a → 0.3.0.a

data/lib/skippy/module_manager.rb

@@ -1,5 +1,7 @@
+require 'fileutils'
 require 'json'
 require 'pathname'
+require 'set'
 
 require 'skippy/helpers/file'
 require 'skippy/lib_module'
@@ -16,17 +18,12 @@ class Skippy::ModuleManager
   def initialize(project)
     raise TypeError, 'expected a Project' unless project.is_a?(Skippy::Project)
     @project = project
+    @modules = SortedSet.new(discover_modules)
   end
 
   # @yield [Skippy::LibModule]
   def each
-    directories(path).each { |library_path|
-      library_path.each_child { |module_file|
-        next unless module_file.file?
-        next unless module_file.extname == '.rb'
-        yield Skippy::LibModule.new(module_file)
-      }
-    }
+    @modules.each { |lib_module| yield lib_module }
     self
   end
 
@@ -37,33 +34,52 @@ class Skippy::ModuleManager
   # @param [String] module_name
   # @return [Skippy::LibModule, nil]
   def find_module(module_name)
-    find { |lib_module| lib_module.name == module_name }
+    find { |lib_module| lib_module.name.casecmp(module_name).zero? }
   end
 
   # @param [Skippy::LibModule, String] lib_module
   def installed?(lib_module)
-    module_name = lib_module.is_a?(Skippy::LibModule) ? lib_module.name : lib_module
-    project = Skippy::Project.current
-    project && project.config.get(:modules, []).any? { |mod| mod == module_name }
+    module_name = lib_module.name
+    modules = project && project.config.get(:modules, [])
+    modules.any? { |mod| mod.casecmp(module_name).zero? }
   end
 
   # @param [String] module_name
   # @return [Skippy::LibModule]
   def use(module_name)
     raise Skippy::Project::ProjectNotSavedError unless project.exist?
-
-    lib_module = project.libraries.find_module(module_name)
-    raise Skippy::LibModule::ModuleNotFoundError,
-          "module '#{module_name}' not found" if lib_module.nil?
+    lib_module = project.libraries.find_module_or_fail(module_name)
 
     source = lib_module.path
-    target = path.join(lib_module.library.name, lib_module.path.basename)
+    target = vendor_path.join(lib_module.library.name, lib_module.path.basename)
+
+    copy_module(lib_module, source, target)
+    @modules << lib_module
+
+    lib_module
+  end
+
+  # @param [Skippy::Library]
+  # @return [Array<Skippy::LibModule>]
+  def update(library)
+    raise Skippy::Project::ProjectNotSavedError unless project.exist?
+    installed = select { |mod| mod.library.name.casecmp(library.name).zero? }
+    installed.each { |mod| use(mod.name) }
+    installed
+  end
 
-    copy_module(source, target)
+  # @param [String] module_name
+  # @return [Skippy::LibModule]
+  def remove(module_name)
+    raise Skippy::Project::ProjectNotSavedError unless project.exist?
+    lib_module = project.libraries.find_module_or_fail(module_name)
 
-    project.config.push(:modules, lib_module.to_s)
+    target = vendor_path.join(lib_module.library.name, lib_module.path.basename)
+    support = vendor_path.join(lib_module.library.name, lib_module.basename)
+    target.delete if target.exist?
+    support.rmtree if support.directory?
 
-    project.save
+    @modules.delete_if { |mod| mod.name.casecmp(lib_module.name).zero? }
 
     lib_module
   end
@@ -72,22 +88,70 @@ class Skippy::ModuleManager
   def length
     to_a.length
   end
-  alias :size :length
+  alias size length
 
   # @return [Pathname]
-  def path
-    project.path.join('src', project.namespace.to_underscore, 'vendor')
+  def vendor_path
+    project.extension_source.join(project.basename, 'vendor')
   end
 
   private
 
+  # @return [Array<Skippy::LibModule>]
+  def discover_modules
+    modules = []
+    project.libraries.each { |library|
+      library_vendor_path = vendor_path.join(library.name)
+      next unless library_vendor_path.directory?
+      library_vendor_path.each_child { |module_file|
+        next unless module_file.file?
+        next unless module_file.extname.casecmp('.rb').zero?
+        modules << Skippy::LibModule.new(library, module_file)
+      }
+    }
+    modules
+  end
+
+  # @param [Skippy::LibModule] lib_module
+  # @param [Pathname, String] source
+  # @param [Pathname, String] target
+  def copy_module(lib_module, source, target)
+    # Copy the main library file.
+    copy_file(lib_module, source, target)
+    # Copy optional support folder.
+    basename = source.basename('.*')
+    source_support_folder = source.parent.join(basename)
+    return unless source_support_folder.directory?
+    target_support_folder = target.parent.join(basename)
+    copy_directory(lib_module, source_support_folder, target_support_folder)
+  end
+
+  # @param [Skippy::LibModule] lib_module
   # @param [Pathname, String] source
   # @param [Pathname, String] target
-  def copy_module(source, target)
+  def copy_directory(lib_module, source_path, target_path)
+    Dir.glob("#{source_path}/**/*") { |filename|
+      source = Pathname.new(filename)
+      next unless source.file?
+      relative_path = source.relative_path_from(source_path)
+      target = target_path.join(relative_path)
+      copy_file(lib_module, source, target)
+    }
+  end
+
+  # @param [Skippy::LibModule] lib_module
+  # @param [Pathname, String] source
+  # @param [Pathname, String] target
+  def copy_file(lib_module, source, target)
     FileUtils.mkdir_p(target.parent)
-    content = File.read(source)
-    transform_module(content)
-    File.write(target, content)
+    if source.extname.casecmp('.rb').zero?
+      content = File.read(source)
+      transform_require(lib_module, content)
+      transform_module(content)
+      File.write(target, content)
+    else
+      File.copy(source, target)
+    end
   end
 
   # Transform the module content with `SkippyLib` placeholder replaced with
@@ -100,4 +164,18 @@ class Skippy::ModuleManager
     content
   end
 
+  LIB_REQUIRE_PATTERN = %r{(\brequire ["'])(modules)(/[^"']*["'])}
+
+  # Transform the require statements to the target destination.
+  #
+  # @param [Skippy::LibModule] lib_module
+  # @param [String] content
+  # @return [String]
+  def transform_require(lib_module, content)
+    relative_path = vendor_path.relative_path_from(project.extension_source)
+    target_path = relative_path.join(lib_module.library.name)
+    content.gsub!(LIB_REQUIRE_PATTERN, "\\1#{target_path}\\3")
+    content
+  end
+
 end

data/lib/skippy/namespace.rb

@@ -13,6 +13,22 @@ class Skippy::Namespace
     to_a.last
   end
 
+  # Creates a compact string from the namespace. First part composed of the
+  # capitals from the first part followed by the last item of the namespace.
+  #
+  # The prefix will always have at least two characters.
+  #
+  # If the namespace isn't nested it will just return the namespace string.
+  #
+  # @return [String]
+  def short_name
+    items = to_a
+    return to_s unless items.size > 1
+    initials = items.first.scan(/[[:upper:]]/)
+    prefix = initials.size > 1 ? initials.join : items.first[0, 2]
+    "#{prefix}_#{items.last}"
+  end
+
   def open
     @open ||= to_a.map { |part| "module #{part}" }.join("\n")
   end
@@ -38,7 +54,7 @@ class Skippy::Namespace
   end
 
   def to_underscore
-    basename_words(basename).map { |word| word.downcase }.join('_')
+    basename_words(basename).map(&:downcase).join('_')
   end
 
   private

data/lib/skippy/project.rb

@@ -34,8 +34,8 @@ class Skippy::Project
 
   # @return [Skippy::Project]
   def self.current_or_fail
-    project = self.current
-    raise ProjectNotFoundError unless project.exist?
+    project = current
+    raise ProjectNotFoundError, project.filename unless project.exist?
     project
   end
 
@@ -52,12 +52,24 @@ class Skippy::Project
     @modules = Skippy::ModuleManager.new(self)
   end
 
+  # The basename for the extension's root and support folder.
+  #
+  # @return [String]
+  def basename
+    @config.get(:basename, namespace.short_name)
+  end
+
+  # @param [String] basename
+  def basename=(basename)
+    @config.set(:basename, basename)
+  end
+
   # @yield [filename]
   # @yieldparam [String] filename the path to custom Skippy command
-  def command_files(&block)
+  def command_files
     files_pattern = File.join(path, 'skippy', '**', '*.rb')
     Dir.glob(files_pattern) { |filename|
-      block.call(filename)
+      yield filename
     }
   end
 
@@ -80,9 +92,21 @@ class Skippy::Project
 
   # Commits the project to disk.
   def save
+    @config.set(:libraries, libraries.map(&:to_h))
+    @config.set(:modules, modules.map(&:name))
     @config.save_as(filename)
   end
 
+  # @return [Pathname]
+  def extension_source
+    path.join('src')
+  end
+
+  # @return [Array<String>]
+  def sources
+    @config.get(:sources, defaults[:sources])
+  end
+
   # @return [String]
   def to_json
     JSON.pretty_generate(@config)
@@ -90,14 +114,20 @@ class Skippy::Project
 
   private
 
+  # @return [Hash]
   def defaults
     {
       name: 'Untitled',
       description: '',
       namespace: Skippy::Namespace.new('Untitled'),
+      basename: Skippy::Namespace.new('Untitled').short_name,
       author: 'Unknown',
       copyright: "Copyright (c) #{Time.now.year}",
       license: 'None',
+      sources: %w(
+        github.com
+        bitbucket.org
+      ),
     }
   end
 

data/lib/skippy/version.rb

@@ -1,3 +1,5 @@
 module Skippy
-  VERSION = '0.2.0.a'.freeze
+
+  VERSION = '0.3.0.a'.freeze
+
 end

data/skippy.gemspec

@@ -1,4 +1,5 @@
-# coding: utf-8
+# rubocop:disable all
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'skippy/version'
@@ -23,11 +24,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'git', '~> 1.3'
+  spec.add_dependency 'naturally', '~> 2.1'
+  spec.add_dependency 'thor', '~> 0.19'
+
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'cucumber'
-  spec.add_development_dependency 'aruba'
-
-  spec.add_dependency 'thor'
+  # TODO(thomthom): Need to lock to 2.3 because 2.4 fails with the custom
+  # aruba build.
+  spec.add_development_dependency 'cucumber', '~> 2.3.0'
+  spec.add_development_dependency 'aruba', '~> 0.14.1'
 end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: skippy
 version: !ruby/object:Gem::Version
-  version: 0.2.0.a
+  version: 0.3.0.a
 platform: ruby
 authors:
 - Thomas Thomassen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-27 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: naturally
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !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
@@ -56,44 +98,30 @@ dependencies:
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.1
 description: Automate common tasks for SketchUp extension development, including managing
   library dependencies.
 email:
@@ -105,6 +133,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".gitmodules"
 - ".idea/.rakeTasks"
 - ".idea/codeStyleSettings.xml"
 - ".idea/encodings.xml"
@@ -115,6 +144,8 @@ files:
 - ".idea/runConfigurations/test__skippy.xml"
 - ".idea/skippy.iml"
 - ".idea/vcs.xml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".vscode/launch.json"
 - ".vscode/settings.json"
 - ".vscode/tasks.json"
@@ -125,6 +156,7 @@ files:
 - Skippy.sublime-project
 - app/boot.rb
 - app/commands/debug.rb
+- app/commands/install.rb
 - app/commands/lib.rb
 - app/commands/new.rb
 - app/commands/template.rb
@@ -141,21 +173,41 @@ files:
 - bin/htmldiff
 - bin/ldiff
 - bin/rake
+- bin/rubocop
+- bin/ruby-parse
+- bin/ruby-rewrite
 - bin/setup
 - bin/skippy
 - bin/thor
-- cSpell.json
 - debug/skippy.bat
 - exe/skippy
+- fixtures/my_lib/modules/command.rb
+- fixtures/my_lib/modules/geometry.rb
+- fixtures/my_lib/modules/gl.rb
+- fixtures/my_lib/modules/gl/container.rb
+- fixtures/my_lib/modules/gl/control.rb
+- fixtures/my_lib/modules/gl/nested/nested.rb
+- fixtures/my_lib/modules/tool.rb
 - fixtures/my_lib/skippy.json
-- fixtures/my_lib/src/command.rb
-- fixtures/my_lib/src/geometry.rb
-- fixtures/my_lib/src/tool.rb
 - fixtures/my_project/skippy.json
 - fixtures/my_project/skippy/commands/example.rb
 - fixtures/my_project/src/hello_world.rb
 - fixtures/my_project/src/hello_world/extension.json
 - fixtures/my_project/src/hello_world/main.rb
+- fixtures/project_with_lib/.skippy/libs/my-lib/modules/command.rb
+- fixtures/project_with_lib/.skippy/libs/my-lib/modules/gl.rb
+- fixtures/project_with_lib/.skippy/libs/my-lib/modules/gl/container.rb
+- fixtures/project_with_lib/.skippy/libs/my-lib/modules/gl/control.rb
+- fixtures/project_with_lib/.skippy/libs/my-lib/skippy.json
+- fixtures/project_with_lib/.skippy/libs/my-other-lib/modules/something.rb
+- fixtures/project_with_lib/.skippy/libs/my-other-lib/skippy.json
+- fixtures/project_with_lib/skippy.json
+- fixtures/project_with_lib/skippy/commands/example.rb
+- fixtures/project_with_lib/src/hello_world.rb
+- fixtures/project_with_lib/src/hello_world/extension.json
+- fixtures/project_with_lib/src/hello_world/main.rb
+- fixtures/project_with_lib/src/hello_world/vendor/my-lib/command.rb
+- fixtures/project_with_lib/src/hello_world/vendor/my-other-lib/something.rb
 - lib/skippy.rb
 - lib/skippy/app.rb
 - lib/skippy/cli.rb
@@ -165,7 +217,11 @@ files:
 - lib/skippy/error.rb
 - lib/skippy/group.rb
 - lib/skippy/helpers/file.rb
+- lib/skippy/installer.rb
+- lib/skippy/installer/git.rb
+- lib/skippy/installer/local.rb
 - lib/skippy/lib_module.rb
+- lib/skippy/lib_source.rb
 - lib/skippy/library.rb
 - lib/skippy/library_manager.rb
 - lib/skippy/module_manager.rb
@@ -193,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: CLI development tool for SketchUp extensions.