luban 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 585aa96ddd38e14f5d9881007237a4760ab220e6
-  data.tar.gz: dc579d8755192ad2d36d3cbff05a70cd393f0e41
+  metadata.gz: 03a9c57a554704d306e2a27b7e7275d3f40597aa
+  data.tar.gz: 0daf44cc27a95855104af6c961e7fde2955c5e37
 SHA512:
-  metadata.gz: 804e27345bfa3221dbd8c870bec37ec10cf6e1837a097bfe0b6a4d468a058beeabf15214fb29949172043a0a619670efbfda3942fa8681ba8110b22ad09fa8f0
-  data.tar.gz: 5cb57933081f512293b4be83edfbd7094049d6a01c304eb8b419f300f0666b4d380effd8a3e7c3829730959735d1cd52088417e89b199c19116b50d5ffc083d2
+  metadata.gz: 4a7b0b50e21b604f2309086267db37960632dd69783e12aa3f0a844e19417c0825260d1a20cd8b1bb7344f146a3c9313a1641e68e4bf506e2dff1fb5bd9db0c8
+  data.tar.gz: 5af9a462115a938ef504bcd38d78732fa3bd95ea773a2e4e8a8ce900ab472004aacab5802a6fb4652e65ea202738880dcab879d5e683d5761dfdc9b87becc3d7

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change log
 
+## Version 0.5.0 (Jun 22, 2016)
+
+Minor enhancements:
+  * Added a series of subcommands, #init to
+    * Initialize a Luban deployment project
+    * Initialize a Luban deployment application
+    * Initialize a Luban deployment service
+  * Added deployment project and application skeleton and templates
+
+Bug fixes:
+  * Corrected the checking for profile existence for a deployment application/service
+
 ## Version 0.4.4 (Jun 17, 2016)
 
 Bug fixes:

data/lib/luban/deployment/cli/application/base.rb

@@ -116,6 +116,14 @@ module Luban
         end
       end
 
+      def init_services(args:, opts:)
+        show_app_environment
+        service = args[:service]
+        (service.nil? ? services.values : [services[service]]).each do |s|
+          s.init_service(args: args, opts: opts)
+        end
+      end
+
       protected
 
       def set_parameters
@@ -157,6 +165,21 @@ module Luban
         long_desc "Manage the deployment of application #{display_name} in #{parent.class.name}"
       end
 
+      def setup_tasks
+        setup_init_services
+        super
+      end
+
+      def setup_init_services
+        return unless has_services?
+        service_names = services.keys
+        command :init do
+          desc 'Initialize deployment services'
+          argument :service, 'Service name', within: service_names, required: false, type: :symbol
+          action! :init_services
+        end
+      end
+
       def show_app_environment
         puts "#{display_name} in #{parent.class.name}"
       end

data/lib/luban/deployment/cli/command.rb

@@ -57,13 +57,13 @@ module Luban
 
             task :which do
               desc "Show the real path for the given executable"
-              argument :executable, "Executable to which", short: :e, required: true
+              argument :executable, "Executable to which"
               action! :which
             end
 
             task :whence do
               desc "List packages with the given executable"
-              argument :executable, "Executable to whence", short: :e, required: true
+              argument :executable, "Executable to whence"
               action! :whence
             end
           end

data/lib/luban/deployment/cli/project.rb

@@ -62,6 +62,12 @@ module Luban
         end
       end
 
+      def init_application(args:, opts:)
+        singleton_class.send(:include, Luban::Deployment::Helpers::Generator::Application)
+        define_singleton_method(:application) { args[:application] }
+        create_application_skeleton
+      end
+
       protected
 
       def validate_parameters
@@ -80,7 +86,7 @@ module Luban
 
       def load_libraries
         applications.each do |app|
-          require "#{work_dir}/apps/#{app}/lib/application"
+          require "#{apps_path}/#{app}/lib/application"
         end
       end
 
@@ -90,6 +96,7 @@ module Luban
 
       def setup_cli
         setup_applications
+        setup_init_application
         super
       end
 
@@ -100,9 +107,23 @@ module Luban
       def setup_applications
         @apps = {}
         applications.map(&:to_sym).each do |app|
-          @apps[app] = command(app, base: application_base_class(app))
+          if application_initialized?(app)
+            @apps[app] = command(app, base: application_base_class(app))
+          end
+        end
+      end
+
+      def setup_init_application
+        command :init do
+          desc 'Initialize a Luban deployment application'
+          argument :application, 'Application name', required: true
+          action! :init_application
         end
       end
+
+      def application_initialized?(app)
+        File.file?("#{apps_path}/#{app}/config/deploy/#{stage}.rb")
+      end
     end
   end
 end

data/lib/luban/deployment/cli/service/base.rb

@@ -24,11 +24,36 @@ module Luban
         end
         service_action :update_profile, dispatch_to: :configurator, locally: true
 
+        def has_templates?
+          respond_to?(:default_templates_path, true)
+        end
+
+        def init_service(args:, opts:)
+          return unless has_templates?
+          require 'fileutils'
+          puts "  Initializing #{name} profile"
+          templates_path = config_finder[:application].profile_templates_path.join(name.to_s)
+          profile_path = config_finder[:application].stage_profile_path.join(name.to_s)
+          [templates_path, profile_path].each { |p| FileUtils.mkdir(p) unless p.directory? }
+          init_templates.each do |src_path|
+            next unless src_path.file?
+            dst_path = (src_path.extname == '.erb' ? templates_path : profile_path).
+                       join(src_path.basename)
+            print "    - #{dst_path.basename}"
+            if dst_path.file?
+              puts " [skipped]"
+            else
+              FileUtils.cp(src_path, dst_path)
+              puts " [created]"
+            end
+          end
+        end
+
         protected
 
         def on_configure
           super
-          include_default_templates_path if respond_to?(:default_templates_path, true)
+          include_default_templates_path if has_templates?
         end
 
         def include_default_templates_path
@@ -43,6 +68,10 @@ module Luban
           super
           linked_dirs.push('log', 'pids')
         end
+
+        def init_templates
+          default_templates_path.children
+        end
       end
     end
   end

data/lib/luban/deployment/helpers/configuration.rb

@@ -107,9 +107,9 @@ module Luban
             def base_path; base_path ||= target.apps_path.join(target.application); end
 
             def has_profile?
-              stage_profile_templates_path.directory? or
-              stage_profile_path.directory? or
-              profile_templates_path.directory?
+              !Dir["#{stage_profile_templates_path}/**/*"].empty? or
+              !Dir["#{stage_profile_path}/**/*"].empty? or
+              !Dir["#{profile_templates_path}/**/*"].empty?
             end
 
             def find_template_file(file_name)

data/lib/luban/deployment/helpers/generator.rb

@@ -0,0 +1,134 @@
+require 'fileutils'
+
+module Luban
+  module Deployment
+    module Helpers
+      module Generator
+        using Luban::CLI::CoreRefinements
+
+        module Base
+          protected
+
+          def skeletons_path
+            @skeletons_path ||= 
+              Pathname.new(__FILE__).dirname.join('..').join('templates').realpath
+          end
+
+          def copy_dir(src_path, dst_path, stages: [], depth: 1)
+            indent = '  ' * depth
+            print  indent + "- #{dst_path.basename}"
+            mkdir(dst_path)
+            src_files = []
+            src_path.each_child do |p|
+              if p.directory?
+                if placeholder?(p.basename)
+                  stages.each do |s| 
+                    copy_dir(p, dst_path.join(staged_basename(s, p.basename)), depth: depth + 1)
+                  end
+                else
+                  copy_dir(p, dst_path.join(p.basename), stages: stages, depth: depth + 1)
+                end
+              else
+                src_files << p
+              end
+            end
+            src_files.each do |f|
+              basename = f.basename
+              action = :copy_file
+              if basename.extname == '.erb'
+                basename = basename.sub_ext('')
+                action = :render_file
+              end
+              if placeholder?(basename)
+                stages.each do |stage|
+                  n = staged_basename(stage, basename)
+                  print indent + "  - #{n}"
+                  send(action, f, dst_path.join(n), context: binding)
+                end
+              else
+                print indent + "  - #{basename}"
+                send(action, f, dst_path.join(basename))
+              end
+            end
+          end
+
+          def mkdir(path)
+            if path.directory?
+              puts " [skipped]"
+            else
+              FileUtils.mkdir(path)
+              puts " [created]"
+            end
+          end
+
+          def copy_file(src_path, dst_path)
+            if dst_path.file?
+              puts " [skipped]"
+            else
+              FileUtils.cp(src_path, dst_path)
+              puts " [created]"
+            end
+          end
+
+          def render_file(template_path, output_path, context: binding)
+            if output_path.file?
+              puts " [skipped]"
+            else
+              require 'erb'
+              File.open(output_path, 'w') do |f|
+                f.write ERB.new(File.read(template_path), nil, '<>').result(context)
+              end
+              puts " [created]"
+            end
+          end
+
+          def placeholder?(basename)
+            basename.to_s =~ /^__stage/
+          end
+
+          def staged_basename(stage, basename)
+            basename.to_s.sub!(/^__stage/, stage)
+          end
+        end
+
+        module Project
+          include Base
+
+          def project_skeleton_path
+            @project_skeleton_path ||= skeletons_path.join('project')
+          end
+
+          def project_target_path
+            @project_target_path ||= (work_dir or Pathname.pwd.join(project))
+          end
+
+          def create_project_skeleton
+            puts "Creating skeleton for project #{project.camelcase}"
+            copy_dir(project_skeleton_path, project_target_path, stages: stages)
+          end
+        end
+
+        module Application
+          include Base
+
+          def application_skeleton_path
+            @application_skeleton_path ||= skeletons_path.join('application')
+          end
+
+          def application_target_path
+            @application_target_path ||= apps_path.join(application)
+          end
+
+          def application_name
+            "#{project}:#{application}".camelcase
+          end
+
+          def create_application_skeleton
+            puts "Creating skeleton for #{stage} application #{application_name}"
+            copy_dir(application_skeleton_path, application_target_path, stages: [stage])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/luban/deployment/helpers.rb

@@ -1,2 +1,3 @@
 require_relative 'helpers/configuration'
-require_relative 'helpers/utils'
+require_relative 'helpers/utils'
+require_relative 'helpers/generator'

data/lib/luban/deployment/runner.rb

@@ -20,6 +20,12 @@ module Luban
         @config_file ||= work_dir.join(lubanfile)
       end
 
+      def init_project(args:, opts:)
+        set_default :project, args[:project]
+        singleton_class.send(:include, Luban::Deployment::Helpers::Generator::Project)
+        create_project_skeleton
+      end
+
       protected
 
       def on_configure
@@ -31,12 +37,14 @@ module Luban
         end
       end
 
-      def set_default_parameters
+      def set_default_common_parameters
         %i(luban_roles luban_root_path stages).each { |p| set_default p, rc[p.to_s] }
+        set_default :user, (rc['user'] || ENV['USER'])
+      end
 
+      def set_default_project_parameters
         set_default :applications, find_applications
         set_default :project, File.basename(work_dir)
-        set_default :user, (rc['user'] || ENV['USER'])
       end
 
       def find_applications
@@ -73,11 +81,13 @@ module Luban
 
       def setup_cli_with_projects
         load_configuration_file(config_file)
-        set_default_parameters
+        set_default_common_parameters
+        set_default_project_parameters
         load_libraries
 
         version Luban::Deployment::VERSION
         desc "Manage the deployment of project #{project.camelcase}"
+        setup_init_project(false)
         setup_projects
       end
 
@@ -96,10 +106,19 @@ module Luban
       end
 
       def setup_cli_without_projects
+        set_default_common_parameters
+
         version Luban::Deployment::VERSION
         desc "Framework to manage project deployment"
-        action do
-          abort "Aborted! NOT a Luban project (or any of the parent directories): #{lubanfile} is NOT found."
+        
+        setup_init_project
+      end
+
+      def setup_init_project(new_project = true)
+        command :init do
+          desc 'Initialize a Luban deployment project'
+          argument :project, 'Project name', required: true if new_project
+          action! :init_project
         end
       end
     end

data/lib/luban/deployment/templates/application/config/deploy/__stage.rb.erb

@@ -0,0 +1,4 @@
+# Deployment configuration for <%= stage %> application <%= application_name %>
+
+# Application servers
+role :app, `hostname -f`.chomp

data/lib/luban/deployment/templates/application/config/deploy.rb.erb

@@ -0,0 +1 @@
+# Deployment configuration for application <%= application_name %>

data/lib/luban/deployment/templates/application/lib/application.rb.erb

@@ -0,0 +1,4 @@
+class <%= project.camelcase %>
+  class <%= application.camelcase %> < Luban::Deployment::Application
+  end
+end

data/lib/luban/deployment/templates/project/CHANGELOG.md.erb

@@ -0,0 +1,6 @@
+# Change log
+
+## Version 0.1.0 (<%= Time.now().strftime("%b %d, %Y") %>)
+
+New features:
+  * Craeted Luban deployment project to manage the <%= project.camelcase %> enivironment.

data/lib/luban/deployment/templates/project/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'luban'

data/lib/luban/deployment/templates/project/LICENSE.txt.erb

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <%= Time.now.year %> <%= user.capitalize %>
+
+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/lib/luban/deployment/templates/project/Lubanfile.rb.erb

@@ -0,0 +1 @@
+stages %w(<%= stages.join(' ') %>)

data/lib/luban/deployment/templates/project/README.md.erb

@@ -0,0 +1,4 @@
+<%= project.camelcase %> 
+====
+
+Luban deployment project to manage the <%= project.camelcase %> enivironment.

data/lib/luban/deployment/templates/project/config/deploy/__stage.rb.erb

@@ -0,0 +1 @@
+# Deployment configuration for <%= stage %> project <%= project.camelcase %>

data/lib/luban/deployment/templates/project/config/deploy.rb.erb

@@ -0,0 +1,4 @@
+# Deployment configuration for project <%= project.camelcase %>
+
+# Specify process monitor
+# process_monitor_via 'monit'

data/lib/luban/deployment/templates/project/lib/project.rb.erb

@@ -0,0 +1,3 @@
+class <%= project.camelcase %> < Luban::Deployment::Project
+  VERSION = '0.1.0'
+end

data/lib/luban/deployment/version.rb

@@ -1,5 +1,5 @@
 module Luban
   module Deployment
-    VERSION = "0.4.4"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luban
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Rubyist Lei
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2016-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: luban-cli
@@ -134,6 +134,7 @@ files:
 - lib/luban/deployment/error.rb
 - lib/luban/deployment/helpers.rb
 - lib/luban/deployment/helpers/configuration.rb
+- lib/luban/deployment/helpers/generator.rb
 - lib/luban/deployment/helpers/utils.rb
 - lib/luban/deployment/packages/bundler.rb
 - lib/luban/deployment/packages/git.rb
@@ -143,8 +144,25 @@ files:
 - lib/luban/deployment/packages/yaml.rb
 - lib/luban/deployment/parameters.rb
 - lib/luban/deployment/runner.rb
+- lib/luban/deployment/templates/application/config/deploy.rb.erb
+- lib/luban/deployment/templates/application/config/deploy/__stage.rb.erb
+- lib/luban/deployment/templates/application/config/deploy/__stage/packages/.gitkeep
+- lib/luban/deployment/templates/application/config/deploy/__stage/profile/.gitkeep
+- lib/luban/deployment/templates/application/config/deploy/__stage/templates/.gitkeep
+- lib/luban/deployment/templates/application/config/templates/profile/.gitkeep
+- lib/luban/deployment/templates/application/lib/application.rb.erb
 - lib/luban/deployment/templates/envrc.erb
 - lib/luban/deployment/templates/header.erb
+- lib/luban/deployment/templates/project/CHANGELOG.md.erb
+- lib/luban/deployment/templates/project/Gemfile
+- lib/luban/deployment/templates/project/LICENSE.txt.erb
+- lib/luban/deployment/templates/project/Lubanfile.rb.erb
+- lib/luban/deployment/templates/project/README.md.erb
+- lib/luban/deployment/templates/project/apps/.gitkeep
+- lib/luban/deployment/templates/project/config/deploy.rb.erb
+- lib/luban/deployment/templates/project/config/deploy/__stage.rb.erb
+- lib/luban/deployment/templates/project/config/templates/.gitkeep
+- lib/luban/deployment/templates/project/lib/project.rb.erb
 - lib/luban/deployment/templates/unset_envrc.erb
 - lib/luban/deployment/version.rb
 - lib/luban/deployment/worker.rb