cableguy 0.2.3 → 0.5.0.pre2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 545e7bcbee6bcfe47a9fac4fffc57f57a9adffa1
+  data.tar.gz: 31bd947e819681b59cb496ebf8a67c7df4e75d5e
+SHA512:
+  metadata.gz: f1da5aa67c675b32d302f398003d2349900e80b013221dd30bc0c6d4fa1fd500aec366195d3b5fd4453c294f55ba5c5268b10a455be199c20026a1b029138813
+  data.tar.gz: d1df4ebf2b0eb784378dc6d1e811190769de97633b5a42622f485bb10deb933d4a4f463e97166228d368997a472bd913065097cd97319d0e0efe4217ee5d6db9

data/.gitignore

@@ -1,4 +1,62 @@
+# Source:
+# https://github.com/github/gitignore/blob/master/Ruby.gitignore
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# 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
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
 *.gem
 .bundle
-Gemfile.lock
 pkg/*
+test/*/test.sqlite3
+test/**/test.sqlite3
+.cabling.yml
+.#*
+test/app/config/blog.yml

data/Gemfile

@@ -1,7 +1,8 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-gem "sqlite3"
-gem "sequel"
-
-# Specify your gem's dependencies in cableguy.gemspec
 gemspec
+
+group :development, :test do
+  gem 'gemfury'
+  gem 'minitest'
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    cableguy (0.5.0.pre2)
+      sequel
+      sqlite3
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    gemfury (0.6.0)
+      faraday (>= 0.9.0, < 0.10.0.pre)
+      highline (~> 1.6.0)
+      multi_json (~> 1.10)
+      netrc (~> 0.10.0)
+      thor (>= 0.14.0, < 1.0.0.pre)
+    highline (1.6.21)
+    minitest (5.10.1)
+    multi_json (1.12.1)
+    multipart-post (2.0.0)
+    netrc (0.10.3)
+    sequel (4.45.0)
+    sqlite3 (1.3.13)
+    thor (0.19.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cableguy!
+  gemfury
+  minitest
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2017-onwards Cebu Code Camp
+Copyright (c) pre-2017 Caresharing
+
+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,28 @@
+## Overview
+
+Compile configuration files based on a template and a cabling DB. Cabling DB is a key-value store, defined using a ruby-based DSL.
+
+## How to use
+
+...
+
+## How to contribute
+
+Please fork, modify, test, and send a PR. If making a change, please add a test code, or update existing ones.
+
+```
+bundle
+rake
+```
+
+## Origins
+
+Cableguy started as an internal dev library at [Caresharing](https://caresharing.com). This is a fork from that, with a clean Git history.
+
+CCC version, started with v0.5.0. All prior are still the internal versions.
+
+While at Caresharing, originally authored by @poysama and @markjeee. For current contributors, please see this project's commit history.
+
+## License
+
+See [LICENSE.md](/LICENSE.md) file.

data/Rakefile

@@ -1 +1,23 @@
-require "bundler/gem_tasks"
+$:.push File.expand_path("../lib", __FILE__)
+require 'palmade/cableguy/version'
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'minitest'
+
+Rake::TestTask.new do |t|
+  t.libs << %w(test lib)
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test
+
+FURY_USERNAME = 'cebucodecamp'
+
+desc 'Build gem and push to gem repo to staging (repo.fury.io/cebucodecamp)'
+task :build_and_stage => [ :build ] do
+  gem_path = File.expand_path('../pkg/cableguy-%s.gem' % Palmade::Cableguy::VERSION, __FILE__)
+  cmd = 'bundle exec fury push --as=%s %s' % [ FURY_USERNAME, gem_path ]
+
+  puts cmd; system(cmd); puts "\n"
+end

data/bin/cable

@@ -1,40 +1,5 @@
 #!/usr/bin/env ruby
 
-CABLE_LIB_PATH = File.expand_path(File.join(File.dirname(__FILE__), '../lib/palmade'))
-require File.join(CABLE_LIB_PATH, 'cableguy')
-require 'optparse'
-
-options = {}
-options[:verbose] = false
-
-optparse = OptionParser.new do |opts|
-  opts.banner = "Set cable options.\n"
-
-  opts.on('-p', '--path PATH', 'Specify cabling path') do |path|
-    options[:path] = path
-  end
-
-  opts.on('-l', '--location LOCATION', 'Specify cabling location') do |location|
-    options[:location] = location
-  end
-
-  opts.on('-t', '--target TARGET', 'Specify cabling target') do |target|
-    options[:target] = target
-  end
-
-  opts.on('-v', '--verbose', 'Verbose logging') do
-    options[:verbose] = true
-  end
-
-  opts.on('-h', '--help', 'Help screen') do
-    puts opts
-    exit
-  end
-end
-
-
-optparse.parse!
-
-Palmade::Cableguy::Runner.run(Dir.pwd, ARGV.shift, options)
-
+require 'palmade/cableguy'
 
+Palmade::Cableguy::CLI.start(ARGV)

data/cableguy.gemspec

@@ -1,26 +1,24 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$:.push File.expand_path('../lib', __FILE__)
 require 'palmade/cableguy/version'
 
 Gem::Specification.new do |s|
-  s.name        = "cableguy"
+  s.name        = 'cableguy'
   s.version     = Palmade::Cableguy::VERSION
-  s.authors     = ["Jan Mendoza"]
-  s.email       = ["poymode@gmail.com"]
-  s.homepage    = "https://github.com/poymode/cableguy"
-  s.summary     = %q{Generate rails configurations from a sqlite key-value storage}
-  s.description = %q{cableguy}
 
-  s.rubyforge_project = "cableguy"
-  s.add_dependency "sqlite3"
-  s.add_dependency "sequel"
+  s.authors     = [ 'Cebu Code Campers' ]
+  s.email       = [ 'core@cebucodecamp.org' ]
+  s.homepage    = 'https://github.com/cebucodecamp/cableguy'
+
+  s.summary     = %q{Generate configurations based on a template and a cabling database}
+  s.description = %q{Generate configurations based on a template and a cabling database}
+  s.rubyforge_project = 'cableguy'
+
+  s.add_dependency 'sqlite3'
+  s.add_dependency 'sequel'
+  s.add_dependency 'thor'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = [ 'lib' ]
 end

data/lib/palmade/cableguy/builders/cable_chmod.rb

@@ -2,11 +2,9 @@ module Palmade::Cableguy
   class Builders::CableChmod < Cable
     add_as :chmod
 
-    def configure(cabler, cabling, target)
-      cabler.say_with_time "changing permissions #{args.join(' -> ')}" do
-        FileUtils.chmod(@args.shift.to_i(8), File.join(cabler.app_root, @args.shift))
-      end
+    def configure(cabler)
+      FileUtils.chmod(@args.shift.to_i(8),
+                      File.join(cabler.determine_apply_path, @args.shift))
     end
   end
 end
-

data/lib/palmade/cableguy/builders/cable_copy.rb

@@ -2,11 +2,8 @@ module Palmade::Cableguy
   class Builders::CableCopy < Cable
     add_as :copy
 
-    def configure(cabler, cabling, target)
-      cabler.say_with_time "copying #{@args.join(' -> ')}" do
-        FileUtils.cp(@args.shift, @args.shift)
-      end
+    def configure(cabler)
+      FileUtils.cp(@args.shift, @args.shift)
     end
   end
 end
-

data/lib/palmade/cableguy/builders/cable_custom.rb

@@ -2,11 +2,14 @@ module Palmade::Cableguy
   class Builders::CableCustom < Cable
     add_as :custom
 
-    def configure(cabler, cabling, target)
+    def configure(cabler)
       unless @block.nil?
-        @block.call(self)
+        if @block.arity == 2
+          @block.call(self, cabler)
+        else
+          @block.call(self)
+        end
       end
     end
   end
 end
-

data/lib/palmade/cableguy/builders/cable_mkdir.rb

@@ -2,13 +2,10 @@ module Palmade::Cableguy
   class Builders::CableMkdir < Cable
     add_as :mkdir
 
-    def configure(cabler, cabling, target)
-      cabler.say_with_time "mkdir #{@args.join(' ')}" do
-        @args.each do |path|
-          FileUtils.mkdir_p(File.join(cabler.app_root, path))
-        end
+    def configure(cabler)
+      @args.each do |path|
+        FileUtils.mkdir_p(File.join(cabler.determine_apply_path,  path))
       end
     end
   end
 end
-

data/lib/palmade/cableguy/builders/cable_move.rb

@@ -2,11 +2,8 @@ module Palmade::Cableguy
   class Builders::CableMove < Cable
     add_as :move
 
-    def configure(cabler, cabling, target)
-      cabler.say_with_time "moving #{@args.join(' -> ')}" do
-        FileUtils.mv(@args.shift, @args.shift)
-      end
+    def configure(cabler)
+      FileUtils.mv(@args.shift, @args.shift)
     end
   end
 end
-

data/lib/palmade/cableguy/builders/cable_symlink.rb

@@ -2,14 +2,11 @@ module Palmade::Cableguy
   class Builders::CableSymlink < Cable
     add_as :symlink
 
-    def configure(cabler, cabling, target)
+    def configure(cabler)
+      source = @args[0]
+      destination = @args[1]
 
-    source = @args.shift
-    destination = @args.shift
-      cabler.say_with_time "creating symlink #{source} -> #{destination}" do
-        FileUtils.ln_s(source, destination, :force => true)
-      end
+      FileUtils.ln_s(source, destination, :force => true)
     end
   end
 end
-

data/lib/palmade/cableguy/builders/cable_template.rb

@@ -2,17 +2,33 @@ module Palmade::Cableguy
   class Builders::CableTemplate < Cable
     add_as :template
 
-    def configure(cabler, cabling, target)
-      cabler.say_with_time "configuring #{@args[0]}" do
-        unless @args[1].nil?
-          target_path = File.join(cabler.app_root, @args[1], @args[0])
-        else
-          target_path = nil
-        end
+    def configure(cabler)
+      templates_apply_path = cabler.determine_apply_path(:for_templates => true)
+      template_file = @args[0]
 
-        install_template(@args[0], cabler, cabling, target, target_path)
+      unless @args[1].nil?
+        target_path = File.join(cabler.determine_apply_path, @args[1], template_file)
+      else
+        target_path = File.join(templates_apply_path, template_file)
+      end
+
+      install_template(template_file, cabler, target_path)
+    end
+
+    def install_template(template_file, cabler, target_path = nil)
+      templates_apply_path = cabler.determine_apply_path(:for_templates => true)
+
+      template_path = File.join(cabler.templates_path, template_file)
+      if target_path.nil?
+        target_path = File.join(templates_apply_path, template_file)
+      end
+
+      if File.exists?(template_path)
+        tb = TemplateBinding.new(self, cabler)
+        tb.install(template_path, target_path)
+      else
+        raise ArgumentError, "template file %s not found" % template_path
       end
     end
   end
 end
-

data/lib/palmade/cableguy/builders.rb

@@ -10,13 +10,12 @@ module Palmade::Cableguy
       CableCopy
     end
 
-    autoload :CableChmod, File.join(File.dirname(__FILE__), 'builders/cable_chmod')
-    autoload :CableCustom, File.join(File.dirname(__FILE__), 'builders/cable_custom')
-    autoload :CableMkdir, File.join(File.dirname(__FILE__), 'builders/cable_mkdir')
-    autoload :CableSymlink, File.join(File.dirname(__FILE__), 'builders/cable_symlink')
-    autoload :CableTemplate, File.join(File.dirname(__FILE__), 'builders/cable_template')
-    autoload :CableMove, File.join(File.dirname(__FILE__), 'builders/cable_move')
-    autoload :CableCopy, File.join(File.dirname(__FILE__), 'builders/cable_copy')
+    autoload :CableChmod,'palmade/cableguy/builders/cable_chmod'
+    autoload :CableCustom,'palmade/cableguy/builders/cable_custom'
+    autoload :CableMkdir,'palmade/cableguy/builders/cable_mkdir'
+    autoload :CableSymlink,'palmade/cableguy/builders/cable_symlink'
+    autoload :CableTemplate,'palmade/cableguy/builders/cable_template'
+    autoload :CableMove,'palmade/cableguy/builders/cable_move'
+    autoload :CableCopy,'palmade/cableguy/builders/cable_copy'
   end
 end
-

data/lib/palmade/cableguy/cable.rb

@@ -32,31 +32,8 @@ module Palmade::Cableguy
       @block = block
     end
 
-    def configure(cabler, cabling, target, &block)
+    def configure(cabler, &block)
       puts "Not implemented: #{self.class.build_key}"
     end
-
-    protected
-
-    def install_template(template_file, cabler, cabling, target, target_path = nil)
-      app_root = cabler.app_root
-
-      template_path = File.join(app_root, DEFAULT_TEMPLATES_PATH, template_file)
-      if target_path.nil?
-        target_path = File.join(app_root, DEFAULT_TARGET_PATH, template_file)
-      end
-
-      if File.exists?(template_path)
-        cabler.say "installing template file: #{template_file}", true
-
-        tb = TemplateBinding.new(self, cabler, cabling, target)
-        tb.install(template_path, target_path)
-      else
-        raise ArgumentError, "template file #{template_file} not found in #{DEFAULT_TEMPLATES_PATH}"
-      end
-    end
   end
-
-  Builders.load_all_builders
 end
-

data/lib/palmade/cableguy/cablefile.rb

@@ -0,0 +1,107 @@
+require 'pathname'
+
+module Palmade::Cableguy
+  class Cablefile < Configurator
+    include Constants
+
+    attr_reader :setups
+
+    attr_reader :file_path
+    attr_reader :app_root
+
+    def self.parse!(cabler)
+      klass = Class.new(self)
+      klass.new(cabler).parse!
+    end
+
+    def initialize(*args)
+      super
+
+      @cabler = args[0]
+      @app_root = @cabler.app_root
+
+      @file_path = nil
+      @setups = [ ]
+    end
+
+    def parse!
+      unless @app_root.nil?
+        @file_path = File.join(@app_root, cablefile_name)
+
+        unless File.exists?(file_path)
+          @file_path = nil
+        end
+      end
+
+      if @file_path.nil?
+        @file_path = find_cable_file
+      end
+
+      unless File.exists?(@file_path)
+        legacy_file_path = File.join(@app_root, legacy_cablefile_name)
+        if File.exists?(legacy_file_path)
+          @file_path = legacy_file_path
+        end
+      end
+
+      if File.exists?(@file_path)
+        configure_from_file(@file_path)
+      end
+
+      self
+    end
+
+    def cabling(*args, &block)
+      if block_given?
+        update_section(:cabling, *args, &block)
+      else
+        call_section(:cabling, *args)
+      end
+    end
+    alias :setup_cabling :cabling
+
+    def setup(what, *args, &block)
+      @setups.push([ what, args, block ])
+    end
+
+    def requirements(*args, &block)
+      if block_given?
+        update_section(:requirements, *args, &block)
+      else
+        call_section(:requirements, *args)
+      end
+    end
+
+    def configured?
+      @sections.include?(:cabling)
+    end
+
+    protected
+
+    def legacy_cablefile_name
+      DEFAULT_LEGACY_CABLEFILE_NAME
+    end
+
+    def cablefile_name
+      DEFAULT_CABLEFILE_NAME
+    end
+
+    def find_cable_file
+      found = nil
+      pname = Pathname.new(@app_root)
+
+      pname.ascend do |path|
+        if File.exists?(File.join(path, cablefile_name))
+          found = path
+          break
+        end
+      end
+
+      unless found.nil?
+        @app_root = found.to_path
+      end
+
+      @file_path = File.join(@app_root, cablefile_name)
+    end
+  end
+end