app_stack 1.2.1 → 1.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTJmNjU5OThhNjgwMjg5MzJjZGVmNjQ2MGU2ZTkzMDNkZGY0NGM5NQ==
+  data.tar.gz: !binary |-
+    ZTA1ODI2N2RlM2U3MTNiZmFkM2NjMmI5ZTdhNWU5NzRiNTE1NDhlMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YzAzMmQ5YzEwNWIzZTI3MDk1MmE1MzMzOWZhOGQ5YWFkMWNkZTJhY2E5OGJl
+    ZjgwOTNiZGRhYjY2MWM3MDdmMGRjOWNmYTVhYjg5ZDE4NGIzMmI0NTNmMTA1
+    ZTUwMWFhZDNkMTg5MzAyYjdmYmMzOTI4ZGUyM2QxYWIyMDk1NTI=
+  data.tar.gz: !binary |-
+    MjVjNDgwNmE1OWQ2YTlhODZhZDgxNDYzZGM4ZGY3YzQ4MjdjMDE5NmNkNTdh
+    NWY2ZWNiYzViYmRmNDkzNTA4MGM2NmU1ZDM2N2RlMDk4OTM5ZWY2MTFkZTI4
+    OWNmNWJjNjk3NDYwYjYxYWUxZGNlNzk0ZDdjZjc0NmRmZTEwN2E=

data/.app_stack.yml

@@ -0,0 +1,14 @@
+stack:
+- la-sinatra: [default, { Gemfile: Gemfile, Procfile: Procfile.imp }]
+- la-mongoid: [default, mixins]
+- la-mancha-models-syobu-p1
+- la-assets-helper
+export: []
+exclude:
+  - '*sample_files/**/*'
+attrs:
+  application_code: ficus_syobu_p1
+  application_name: Ficus Web Framework
+  gems:
+    default: {}
+    development: {}

data/Gemfile

@@ -1,5 +1,6 @@
 source 'http://ruby.taobao.org'
 
+gem 'diffy'
 gem 'tilt', '>= 1.4.1'
 gem 'term-ansicolor', '>= 1.2.2'
 gem 'activesupport', '>= 3.2.14'

data/Gemfile.lock

@@ -9,6 +9,7 @@ GEM
       tzinfo (~> 0.3.37)
     atomic (1.1.13)
     diff-lcs (1.2.4)
+    diffy (3.0.1)
     i18n (0.6.5)
     minitest (4.7.5)
     multi_json (1.8.0)
@@ -37,6 +38,7 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport (>= 3.2.14)
+  diffy
   rspec (>= 2.14.1)
   simplecov (>= 0.7.1)
   term-ansicolor (>= 1.2.2)

data/README.md

@@ -62,6 +62,20 @@ Define directory where the source code of stack modules located. Default is `../
 
 Default as above (refer to document below).
 
+Then run:
+
+    $ stackup [config_file]
+
+Default configuration file is `.app_stack.yml`
+
+Command line options:
+
+- `-h, --help` show help message
+- `--verbose` show more informations
+- `-s, --simulate` only show the copy list, do not actually copy
+- `-f, --force` force overwrite new files (only import new file and
+  ask for updated files by default)
+
 ## Copy Precedence
 
 For a module chain `a, b, c, ...`, files exported by `b` will over-write

data/app_stack.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new 'app_stack', AppStack::VERSION do |s|
   s.email             = 'huangw@7lime.com'
   s.homepage          = 'https://github.com/7lime/app_stack-gem'
   s.files             = `git ls-files`.split("\n") - %w[.gitignore .rspec Rakefile]
+  s.executables       << 'stackup'
   s.license           = 'MIT'
   s.test_files        = Dir.glob('{spec,test}/**/*.rb')
 

data/bin/config_assets

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+Tse

data/bin/stackup

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# vi: ft=ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'app_stack'
+
+AppStack.stackup!

data/lib/app_stack/cli_options.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'optparse'
+
+# parse command line options based
+# rubocop:disable MethodLength
+class CliOptions
+  attr_accessor :force, :simulate, :verbose, :conf_file
+
+  def initialize(argv = ARGV)
+    parse_opt!(argv)
+    case argv.size
+    when 1 then self.conf_file = argv.shift
+    when 0 then self.conf_file = AppStack::DEFAULT_CONF_FILE
+    else fail "too many configuration files (#{argv.join(', ')})."
+    end
+  end
+
+  # parse command line options
+  def parse_opt!(argv)
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = 'Usage: appstack [options] [config_file]'
+
+      opts.separator ''
+      opts.separator 'Available options:'
+
+      opts.on('-f', '--force', 'force overwrite') do
+        self.force = true
+      end
+
+      opts.on('-s', '--simulate', 'simulate only, do not copy') do
+        self.simulate = true
+      end
+
+      opts.on('--verbose', 'show debug messages') do
+        self.verbose = true
+      end
+
+      opts.on_tail('-h', '--help', 'show this message') do
+        puts opts
+        exit
+      end
+
+      opts.on_tail('-v', '--version', 'show version number') do
+        puts AppStack::VERSION
+        exit
+      end
+    end
+
+    opt_parser.parse!(argv)
+  end
+end

data/lib/app_stack/copy_list_builder.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+
+require 'diffy'
+require 'tilt'
+require 'ostruct'
+
+module AppStack
+  # import from outside apps
+  module CopyListBuilder
+    # get exported source file list from app, filtered by import_conf
+    def import_files(import_conf)
+      file_list = {}
+      import_conf.each do |c|
+        if c.is_a?(String) # group name
+          echo "import from group #{c.bold.blue}"
+          file_list.merge! export_files(c)
+        elsif c.is_a?(Hash)
+          echo "import form file: ", c
+          file_list.merge! glob_files(c, true)
+        else
+          fail 'unknown import options: ' + c.inspect
+        end
+      end
+      file_list
+    end
+
+    # render/copy file list
+    def check_mtime
+      @render_files, @copy_candidates = {}, {}
+      @copy_list.each do |f, t|
+        type, f = f.split ':', 2
+
+        # exclude file in the exclude list
+        excluded = false
+        @config[:exclude].each do |patt|
+          if File.fnmatch?(patt, t)
+            echo "exclude #{short_path(t)} by patthern ", patt
+            excluded = true
+            break
+          end
+        end
+        next if excluded
+
+        # check modification time
+        if type == 'c'
+          if newer?(f, t)
+            @copy_candidates[t] = f
+          else
+            echo "skip copy #{short_path(t).blue} (mtime or existence)."
+          end
+        elsif type == 'r'
+          if newer?(f, t) or @attr_mtime > File.mtime(t)
+            @render_files[t] = f
+          else
+            echo "skip render #{short_path(t).blue} (mtime or existence)."
+          end
+        else
+          fail "unknown operation type #{type} for #{short_path(t)}"
+        end
+      end
+    end
+
+    def check_diff
+      @copy_files, @diffs = {}, {}
+      @copy_candidates.each do |t, f|
+        if File.exists?(t)
+          diff = Diffy::Diff.new(f, t, :source => 'files')
+          if diff
+            @diffs[t] = diff
+            @copy_files[t] = f
+          else
+            echo "Skip copy #{short_path(t).blue} (no diff)."
+          end
+        else
+          @copy_files[t] = f
+        end
+      end
+    end
+
+    def merge!
+      check_mtime
+      check_diff
+      echo 'final copy list: ', @copy_files
+      echo 'final diff list: ', @diffs
+      echo 'final render lists: ', @render_files
+
+      if @diffs.keys.size > 0
+        ask_diffs # quit, copy and show diffs special files
+      else
+        do_copy!
+        do_render!
+      end
+    end
+
+    def ask_diffs
+      puts "These files are changed remotely:"
+      i = 1
+      @diffs.each do |t, diff|
+        puts "[#{i.to_s.bold}] " + short_path(t).blue
+        puts "from: #{@copy_files[t].blue}"
+        puts diff.to_s(:color)
+      end
+
+      puts "use -f (--option) option to overwrite all files,"
+      puts "or 'touch' local file to disable warn for specific file."
+    end
+
+    def do_copy!
+      @copy_files.each { |to, fr| copy_file!(fr, to) }
+    end
+
+    def do_render!
+      @render_files.each { |to, fr| render_file!(fr, to) }
+    end
+
+    # if f1 newer than f2, or f2 not exits but f1 does.
+    def newer?(f1, f2)
+      return false unless File.exists?(f1)
+      return true unless File.exists?(f2)
+      File.mtime(f1) > File.mtime(f2)
+    end
+
+    def copy_file!(fr, to)
+      target_dir = File.dirname(to)
+      FileUtils.mkdir_p target_dir unless File.directory?(target_dir)
+      puts "copied #{fr.blue} \n   to: " + to.green.bold
+      FileUtils.copy fr, to
+    end
+
+    def render_file!(fr, to)
+      oh = File.open(to, 'wb')
+      if fr.match(/\.liquid$/)
+        require 'liquid'
+        oh.write Liquid::Template.parse(File.open(fr,
+                                                  'r:utf-8').read).render(attrs)
+      else
+        tilt = Tilt.new(fr)
+        oh.write tilt.render(OpenStruct.new(attrs))
+      end
+      oh.close
+      puts "readered #{fr.blue}\n     to: " + to.green.bold
+    end
+  end
+end

data/lib/app_stack/local_files_parser.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+
+module AppStack
+  # parse local files from a local app directory
+  module LocalFilesParser
+    def attrs
+      @config[:attrs]
+    end
+
+    def directory
+      File.expand_path('../', @file)
+    end
+
+    # use the direct name of the config file as app name
+    def app_name
+      File.basename(directory)
+    end
+
+    def full_path(file)
+      File.expand_path(file, directory)
+    end
+
+    def short_path(path)
+      lpath = path.sub(/^((c|r)\:)?#{directory}\/?/, '')
+      lpath.sub(/^\//, '')
+    end
+
+    # get export files list (copy_from => copy_to hash) for a specific group
+    def export_files(group = 'default')
+      @export_files ||= parse_export_files
+      group = 'default' if group.to_s == 'defaults' # back-compatibility
+      @export_files[group.to_s]
+    end
+
+    # get all exported files in groups
+    def parse_export_files
+      # 'file_group_name' => { copy_from => copy_to_base_name }
+      @export_files ||= {}
+      @config[:export].each do |p_list| # pattern list
+        if p_list.is_a?(Hash) # group, file list
+          p_list.each do |n, p|
+            @export_files[n] ||= {}
+            @export_files[n].merge! find_files(p)
+          end
+        elsif p_list.is_a?(String)
+          @export_files['default'] ||= {}
+          @export_files['default'].merge! find_files([p_list])
+        else
+          fail 'invalid export option ' + p_list.inspect
+        end
+      end
+      @export_files
+    end
+
+    def switch_to_tpl(file)
+      f = full_path(file)
+      tpl_file = nil
+      @config[:tpl_ext].each { |ex| tpl_file = f + ex if File.exists?(f + ex) }
+      tpl_file ? 'r:' + tpl_file : 'c:' + f
+    end
+
+    # from file pattern to copy_from => copy_to (remove directory header) hash
+    def glob_files(dir, allow_hash = false)
+      fhsh = {}
+      if dir.is_a?(Hash)
+        raise 'Can not use hash here for ' + dir.keys.join.to_s + ' in file ' +
+          filename unless allow_hash
+        dir.each do |f, t|
+          t = '/' + t.gsub(/^\//, '')
+          fhsh[switch_to_tpl(f)] = t
+          echo "found: #{short_path(switch_to_tpl(f)).blue} to: ",
+               short_path(t)
+        end
+      else
+        Dir[File.expand_path(dir, directory)].each do |f|
+          fhsh[switch_to_tpl(f)] = f.gsub(/^#{directory}/, '')
+          echo "found: #{short_path(switch_to_tpl(f)).blue} to: ",
+               short_path(short_path(f.gsub(/^#{directory}/, '')))
+        end
+      end
+
+      fhsh
+    end
+
+    # from array (or string) of file patterns, glob files and build a
+    # large array
+    def find_files(plist)
+      fhsh = {}
+      plist.each do |file_pattern|
+        fhsh.merge! glob_files(file_pattern)
+      end
+      fhsh
+    end
+  end
+end

data/lib/app_stack/stack_app.rb

@@ -0,0 +1,114 @@
+# encoding: utf-8
+
+require 'yaml'
+require 'pp'
+
+module AppStack
+  # content parse error
+  class ParseError < RuntimeError; end
+
+  # represent a single stacked application
+  class StackApp
+    attr_reader :file_mtime
+
+    include LocalFilesParser
+    include CopyListBuilder
+
+    def initialize(filename, options)
+      @filename, @options = filename, options
+      @file = File.expand_path(filename)
+      @file_mtime = File.mtime(@file)
+
+      # default configuration, also restrict known keys and data type
+      @config = {
+        stack: [],
+        export: [],
+        exclude: [],
+        attrs: {},
+        stack_dir: '..',
+        tpl_ext: %w[.erb .haml .liquid]
+      }
+
+      echo "load app #{app_name.bold} from file:", @file
+      # use yaml file to set configuration
+      YAML.load(File.open(@file, 'r:utf-8').read).each do |k, v|
+        fail ParseError,
+             "unkown option `#{k}` in #{@filename}" unless @config[k.to_sym]
+        fail ParseError,
+             "'#{k}' must be a #{@config[k.to_sym].class.to_s}" unless
+               v.is_a?(@config[k.to_sym].class)
+        echo "set #{k.blue} to: ", v
+        @config[k.to_sym] = v
+      end
+    end
+
+    # load definitions from all apps in the stack config
+    def load_stack
+      unless @stack
+        @stack = { } # stack_app => import list
+        @config[:stack].each do |app_conf|
+          if app_conf.is_a?(String)
+            app_name, groups = app_conf, ['default']
+          elsif app_conf.is_a?(Hash)
+            fail 'invalid app: ' + app_conf.inspect if app_conf.keys.size > 1
+            app_conf.each { |an, ac| app_name, groups = an, ac }
+          else
+            fail 'invalid stack app: ' + app_conf.inspect
+          end
+
+          conf_file = @config[:stack_dir].sub(/\/?$/, '/') + app_name
+          conf_file += '/' + File.basename(@file)
+          app = StackApp.new(conf_file, @options)
+          @stack[app] = groups
+        end
+      end
+      @stack
+    end
+
+    # entry point: copy or simulate copy
+    def stackup!
+      @copy_list = {} # from_file_full_path => copy item
+      new_attrs, @attr_mtime = {}, file_mtime
+      load_stack.each do |app, import_conf|
+        echo 'load files from ' + app.app_name.bold.blue
+
+        # get file list from app
+        app.import_files(import_conf).each do |f, t|
+          @copy_list[f] = full_path(short_path(t))
+        end
+
+        # update global attrs
+        new_attrs.deep_merge! app.attrs
+        @attr_mtime = app.file_mtime if app.file_mtime > @attr_mtime
+      end
+
+      @config[:attrs] = new_attrs.deep_merge attrs
+      echo 'the merged attributes', attrs
+
+      # add local template files the copy list
+      Dir[directory + "/**/*{#{@config[:tpl_ext].join(',')}}"].each do |f|
+        @copy_list['r:' + f] = f.gsub(/#{@config[:tpl_ext].join('|')}$/, '')
+        echo 'found local template file: ',
+             short_path(f) + ' -> ' + short_path(@copy_list['r:' + f])
+      end
+
+      merge!
+    end
+
+    # echo message only if verbose specified to be true
+    def echo(msg, var = nil)
+      return unless @options.verbose
+
+      msg = "[#{app_name || self.class.name}] ".green + msg
+      msg += "\n" if var && var.inspect.size > 30
+
+      print msg
+      if var
+        print Term::ANSIColor.bold
+        var.inspect.size > 30 ? PP.pp(var) : PP.singleline_pp(var)
+        print Term::ANSIColor.reset
+      end
+      puts unless var && var.inspect.size > 30
+    end
+  end
+end

data/lib/app_stack/version.rb

@@ -2,5 +2,5 @@
 
 # AppStack module
 module AppStack
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

data/lib/app_stack.rb

@@ -1,34 +1,25 @@
 # encoding: utf-8
 
-require 'yaml'
-require 'find'
-require 'fileutils'
-require 'ostruct'
-require 'tilt'
-require 'pathname'
-require 'active_support/core_ext/hash/deep_merge'
-
 require 'term/ansicolor'
 # mixin String class for term-color methods
 class String; include Term::ANSIColor end
 
-require 'app_stack/config'
-# require 'app_stack/copier'
-require 'app_stack/merger'
-
-## A namespace for app-stack based modules
-module AppStack
-  CONF_FILE = './.app_stack.yml'
+require 'active_support/core_ext/hash/deep_merge'
 
+require 'app_stack/version'
+require 'app_stack/cli_options'
+require 'app_stack/local_files_parser'
+require 'app_stack/copy_list_builder'
+require 'app_stack/stack_app'
 
-  # based on conf_file, merge up from stack of applications
-  def stackup!(conf_file)
-    # merge files from stacks
-    conf_file ||= CONF_FILE
-    mger = Merger.new(conf_file)
+# module functions for handle stackup
+module AppStack
+  DEFAULT_CONF_FILE  = '.app_stack.yml'
 
-    # not run, just prepare in vobose mode
-    ENV['NR'] ? mger.prepare(true) : mger.merge!
+  # handle the execution to main class:
+  def stackup!(argv = ARGV)
+    @options = CliOptions.new(argv)
+    StackApp.new(@options.conf_file, @options).stackup!
   end
 
   module_function :stackup!

data/tags

@@ -0,0 +1,45 @@
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
+!_TAG_PROGRAM_NAME	Exuberant Ctags	//
+!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
+!_TAG_PROGRAM_VERSION	5.8	//
+AppStack	lib/app_stack.rb	/^module AppStack$/;"	m
+AppStack	lib/app_stack/copy_list_builder.rb	/^module AppStack$/;"	m
+AppStack	lib/app_stack/local_files_parser.rb	/^module AppStack$/;"	m
+AppStack	lib/app_stack/merger.rb	/^module AppStack$/;"	m
+AppStack	lib/app_stack/stack_app.rb	/^module AppStack$/;"	m
+AppStack	lib/app_stack/version.rb	/^module AppStack$/;"	m
+CliOptions	lib/app_stack/cli_options.rb	/^class CliOptions$/;"	c
+CopyListBuilder	lib/app_stack/copy_list_builder.rb	/^  module CopyListBuilder$/;"	m	class:AppStack
+CopyListItem	lib/app_stack/stack_app.rb	/^  class CopyListItem$/;"	c	class:AppStack
+LocalFilesParser	lib/app_stack/local_files_parser.rb	/^  module LocalFilesParser$/;"	m	class:AppStack
+Merger	lib/app_stack/merger.rb	/^  class Merger$/;"	c	class:AppStack
+ParseError	lib/app_stack/stack_app.rb	/^  class ParseError < RuntimeError; end$/;"	c	class:AppStack
+StackApp	lib/app_stack/stack_app.rb	/^  class StackApp$/;"	c	class:AppStack
+String	lib/app_stack.rb	/^class String; include Term::ANSIColor end$/;"	c
+app_name	lib/app_stack/local_files_parser.rb	/^    def app_name$/;"	f	class:AppStack.LocalFilesParser
+attr_mod?	lib/app_stack/merger.rb	/^    def attr_mod?(to)$/;"	f	class:AppStack.Merger
+copy_file!	lib/app_stack/merger.rb	/^    def copy_file!(fr, to)$/;"	f	class:AppStack.Merger
+directory	lib/app_stack/local_files_parser.rb	/^    def directory$/;"	f	class:AppStack.LocalFilesParser
+echo	lib/app_stack/stack_app.rb	/^    def echo(msg, var = nil)$/;"	f	class:AppStack.StackApp
+export_files	lib/app_stack/local_files_parser.rb	/^    def export_files(group = 'default')$/;"	f	class:AppStack.LocalFilesParser
+find_files	lib/app_stack/local_files_parser.rb	/^    def find_files(plist)$/;"	f	class:AppStack.LocalFilesParser
+full_path	lib/app_stack/local_files_parser.rb	/^    def full_path(file)$/;"	f	class:AppStack.LocalFilesParser
+glob_files	lib/app_stack/local_files_parser.rb	/^    def glob_files(dir, allow_hash = false)$/;"	f	class:AppStack.LocalFilesParser
+import_files	lib/app_stack/copy_list_builder.rb	/^    def import_files(import_conf)$/;"	f	class:AppStack.CopyListBuilder
+initialize	lib/app_stack/cli_options.rb	/^  def initialize(argv = ARGV)$/;"	f	class:CliOptions
+initialize	lib/app_stack/merger.rb	/^    def initialize(conf_file, verbose = false)$/;"	f	class:AppStack.Merger
+initialize	lib/app_stack/stack_app.rb	/^    def initialize(filename, options)$/;"	f	class:AppStack.StackApp
+load_stack	lib/app_stack/merger.rb	/^    def load_stack(stack_name, groups)$/;"	f	class:AppStack.Merger
+load_stack	lib/app_stack/stack_app.rb	/^    def load_stack$/;"	f	class:AppStack.StackApp
+merge!	lib/app_stack/merger.rb	/^    def merge!$/;"	f	class:AppStack.Merger
+newer?	lib/app_stack/merger.rb	/^    def newer?(f1, f2)$/;"	f	class:AppStack.Merger
+parse_export_files	lib/app_stack/local_files_parser.rb	/^    def parse_export_files$/;"	f	class:AppStack.LocalFilesParser
+parse_opt!	lib/app_stack/cli_options.rb	/^  def parse_opt!(argv)$/;"	f	class:CliOptions
+parse_stacks	lib/app_stack/merger.rb	/^    def parse_stacks$/;"	f	class:AppStack.Merger
+prepare	lib/app_stack/merger.rb	/^    def prepare(verbose = false)$/;"	f	class:AppStack.Merger
+render_file!	lib/app_stack/merger.rb	/^    def render_file!(fr, to)$/;"	f	class:AppStack.Merger
+short_path	lib/app_stack/local_files_parser.rb	/^    def short_path(path)$/;"	f	class:AppStack.LocalFilesParser
+stackup!	lib/app_stack.rb	/^  def stackup!(argv = ARGV)$/;"	f	class:AppStack
+stackup!	lib/app_stack/stack_app.rb	/^    def stackup!$/;"	f	class:AppStack.StackApp