app_stack 1.1.4 → 1.2.0

data/lib/app_stack/config.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+require 'yaml'
+
+module AppStack
+  class ParseError < RuntimeError; end
+
+  # an object represent information from .app_stack.yml file
+  class Config
+    attr_reader :filename, :copy_list
+
+    def initialize(file)
+      @filename = File.expand_path(file)
+      yml = YAML.load(File.open(@filename, 'r:utf-8').read)
+
+      # default configuration, also restrict known keys and data type
+      @config = {
+        stack: [],
+        export: [],
+        exclude: [],
+        attrs: {},
+        stack_dir: '../',
+        tpl_ext: %w[.erb .haml .liquid]
+      }
+
+      # use yaml file to set configuration
+      yml.each do |k, v|
+        raise ParseError,
+              "unkown option `#{k}` in #{@filename}" unless @config[k.to_sym]
+        raise ParseError,
+              "'#{k}' must be a #{@config[k.to_sym].class.to_s}" unless
+                v.is_a?(@config[k.to_sym].class)
+        @config[k.to_sym] = v
+      end
+
+      # convert stack dir to relative path:
+      @config[:stack_dir] = File.expand_path(@config[:stack_dir],
+                                             File.dirname(@filename))
+
+      # define reader accessors:
+      @config.each do |k, v|
+        self.class.send(:define_method, k.to_sym) { v }
+      end
+
+      # copy list from merge's view point
+      @copy_list = {}
+    end
+
+    def directory
+      File.expand_path('../', filename)
+    end
+
+    # use the direct name of the config file as app name
+    def app_name
+      File.basename(File.dirname(File.expand_path(filename)))
+    end
+
+    def attr_vars
+      @config[:attrs]
+    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
+
+    def exclude_files
+      @export_files ||= find_files(@config[:exclude], false)
+    end
+
+    def add_copy_list(fhsh)
+      if fhsh.is_a?(Hash)
+        fhsh.each do |fr, to|
+          fr = File.expand_path(fr, directory)
+          @copy_list[fr] = to
+        end
+      else
+        @copy_list.merge! export_files(fhsh) # the group's name
+      end
+    end
+
+    private
+
+    # get all exported files in groups
+    def parse_export_files
+      # 'file_group_name' => { copy_from => copy_to_base_name }
+      @export_files ||= {}
+      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
+        else
+          @export_files['default'] ||= {}
+          @export_files['default'].merge! find_files(p_list)
+        end
+      end
+      @export_files
+    end
+
+    # from file pattern to copy_from => copy_to (remove directory header) hash
+    def glob_files(dir, allow_hash)
+      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[File.expand_path(f, directory)] = t
+        end
+      else
+        Dir[File.expand_path(dir, directory)].each do |f|
+          fhsh[f] = f.gsub(/^#{directory}/, '')
+        end
+      end
+      fhsh
+    end
+
+    # from array (or string) of file patterns, glob files and build a
+    # large array
+    def find_files(group, allow_hash = true)
+      group = [ group ] unless group.is_a?(Array)
+      fhsh = {}
+      group.each do |file_pattern|
+        fhsh.merge! glob_files(file_pattern, allow_hash)
+      end
+      fhsh
+    end
+  end
+end

data/lib/app_stack/merger.rb

@@ -0,0 +1,127 @@
+# encoding: utf-8
+
+module AppStack
+  # runner for merge files from stack of apps
+  class Merger
+    attr_reader :stacks, :copy_list, :render_list
+
+    def initialize(conf_file, verbose = false)
+      # load configuration
+      @conf_file = conf_file
+      @config = Config.new(@conf_file)
+      @verbose = verbose
+
+      @stacks = []
+      @attr_vars = {}
+      @attr_last_mod = File.mtime(@conf_file)
+      parse_stacks
+
+      @copy_list = {}
+      @render_list = {}
+      @prepared = false
+    end
+
+    def prepare(verbose = false)
+      local_dir = Pathname.new(@config.directory)
+      @stacks.each do |stack|
+        stack.copy_list.each do |fr, to| # copy from, copy to
+          to = local_dir + to.gsub(/^\//, '')
+          if @config.exclude_files[to.to_s]
+            puts 'keep '.green.bold + to.to_s.gsub(@config.stack_dir, '') if verbose
+          elsif newer?(to, fr)
+            puts 'skip '.white.bold + to.to_s.gsub(@config.stack_dir, '') if verbose
+          else
+            # render list
+            tpl_file = nil
+            @config.tpl_ext.each do |ext|
+              tpl_file = fr + ext if File.exists?(fr + ext)
+            end
+
+            if tpl_file
+              @render_list[to.to_s] = tpl_file if newer?(tpl_file, to) || attr_mod?(to)
+            else
+              @copy_list[to.to_s] = fr if newer?(fr, to)
+            end
+          end
+        end
+        @prepared = true
+      end
+
+      if verbose
+        @copy_list.each do |to, fr|
+          puts 'copy '.bold + fr.gsub(@config.stack_dir, '')
+          puts '  to '.bold + to.to_s.gsub(@config.stack_dir, '')
+        end
+
+        @render_list.each do |to, fr|
+          puts 'render '.bold + fr.gsub(@config.stack_dir, '')
+          puts '    to '.bold + to.to_s.gsub(@config.stack_dir, '')
+        end
+      end
+    end
+
+    def merge!
+      @prepared || prepare(@verbose)
+      @copy_list.each { |to, fr| copy_file!(fr, to) }
+      @render_list.each { |to, fr| render_file!(fr, to) }
+    end
+
+    private
+
+    def copy_file!(fr, to)
+      target_dir = File.dirname(to)
+      FileUtils.mkdir_p target_dir unless File.directory?(target_dir)
+      FileUtils.copy fr, to
+    end
+
+    def render_file!(fr, to)
+      var = @attr_vars.deep_merge(@config.attr_vars)
+      oh = File.open(to, 'wb')
+      if fr.match(/\.liquid$/)
+        require 'liquid'
+        oh.write Liquid::Template.parse(File.open(fr, 'r:utf-8').read).render(var)
+      else
+        tilt = Tilt.new(fr)
+        oh.write tilt.render(OpenStruct.new(var))
+      end
+      oh.close
+    end
+
+    # get a list of stacked app object
+    def parse_stacks
+      @config.stack.each do |stk|
+        case
+        when stk.is_a?(String) then @stacks << load_stack(stk, ['default'])
+        when stk.is_a?(Hash)
+          stk.each { |key, groups| @stacks << load_stack(key, groups) }
+        else
+          raise 'stack must be a string or a hash, in ' + @conf_file
+        end
+      end
+    end
+
+    # read stack from list, set copy_list
+    def load_stack(stack_name, groups)
+      conf_base_name = File.basename(@conf_file)
+      stack_dir = Pathname.new(@config.stack_dir) + stack_name
+      stack = Config.new(stack_dir + conf_base_name)
+      fmodtime = File.mtime(stack_dir + conf_base_name)
+      @attr_last_mod = fmodtime if fmodtime > @attr_last_mod # update file mod time
+      @attr_vars = @attr_vars.deep_merge stack.attr_vars
+      groups.each { |grp| stack.add_copy_list(grp) }
+      stack
+    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 attr_mod?(to)
+      return true unless File.exists?(to)
+      @attr_last_mod > File.mtime(to)
+    end
+  end
+end

data/lib/app_stack/version.rb

@@ -2,5 +2,5 @@
 
 # AppStack module
 module AppStack
-  VERSION = '1.1.4'
+  VERSION = '1.2.0'
 end

data/lib/app_stack.rb

@@ -4,263 +4,32 @@ require 'yaml'
 require 'find'
 require 'fileutils'
 require 'ostruct'
-require 'tilt/erb'
+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'
-
-  # public entry ponit, receive a configuration filename,
-  # copy source files on to the directory contains the
-  # configuration file.
-  def stackup!(conf_file)
-    load_configuration(conf_file)
-
-    register_self!(@app_root)
-    merge_stacks!(@config['stack'])
-    render_self!(@self_files)
-
-    # rewrite configuration back to app-stack file
-    @origin_config['files'] = @files
-    File.open(conf_file, 'wb') { |fh| fh.puts YAML.dump(@origin_config) }
-  end
-
-  # convert directory names, load configuration from yaml file
-  # rubocop:disable MethodLength
-  def load_configuration(conf_file)
-    @conf_file = conf_file || CONF_FILE
-    @config = YAML.load(File.read(@conf_file))
-    @origin_config = @config.dup
-
-    @app_root = @config['app_root'] || File.dirname(@conf_file)
-    @app_root = File.expand_path(@app_root)
-    @stack_dir = @config['stack_dir'] || '../stack_apps'
-    @stack_dir = File.expand_path(@app_root + '/' +
-                      @stack_dir) if @stack_dir.match(/^\.\.?\//)
-
-    # default values
-    @verbose = @config['verbose'] || 1
-    @verbose = @verbose.to_i
-
-    @config['tpl_ext'] ||= '.erb'
-    raise ArgumentError, 'ERROR: `include` key depriciated, ' +
-          'please update your yml file' if @config['include']
-    @config['include'] = []
-    @config['exclude'] ||= []
-    @config['export'] ||= [] # even export can be blank
-    @config['stack'] ||= []
-    @config['files'] ||= {}
-
-    # attrs to assigned into template
-    @attrs = {}
-    # file list under the app_root
-    @self_files = []
-
-    @files = @config['files']
-  end
-
-  # for files already in the app root, register to no-copy list
-  def register_self!(dir)
-    Find.find(dir).each do |f|
-      next if f == dir
-      basename = f.sub(/^#{dir}\//, '')
-      next if basename.match(/^.git$/)
-      next if basename.match(/^.git\W/)
-      next if gitignore_list(dir).include?(basename)
-
-      if @files[basename]
-        carp "From #{'self'.blue.bold} #{basename.bold} ",
-             'keep'.white, 2 if @files[basename] == '__self'
-      else
-        carp "From #{'self'.blue.bold} #{basename.bold}",
-             'registed'.green.bold, 1
-        @files[basename] = '__self'
-      end
-
-      @self_files << f unless @self_files.include?(f)
-    end
-  end
-
-  # render file in app-root
-  def render_self!(files)
-    files.each do |f|
-      if File.exists?(f + @config['tpl_ext'])
-        basename = f.sub(/^#{@app_root}\//, '')
-        carp "From #{'self'.blue.bold} render #{basename.bold}",
-             render_file!(f + @config['tpl_ext'], f), 1
-      end
-    end
-  end
-
-  # copy from a stack of applications
-  def merge_stacks!(stack)
-    stack.each do |app|
-      app_dir, groups = '', ['default']
-      if app.is_a?(Hash)
-        app.each { |k, v| app, groups = k, v }
-      end
-      app_dir = @stack_dir + '/' + app
-
-      raise "no directory found for #{app}" unless File.directory?(app_dir)
-      raise "no configuration found for #{app}" unless
-               File.exists?(app_dir + '/' + File.basename(@conf_file))
-
-      # loop over remote files
-      elist = export_list(app_dir, groups)
-      elist.each do |file|
-        # skip .erb file as template
-        next if file.match(/#{@config['tpl_ext']}$/) &&
-                elist.include?(file.sub(/#{@config['tpl_ext']}$/, ''))
-        # find the absolute path for source and target file for copy
-        src_f = File.expand_path(app_dir + '/' + file)
-        tgt_f = File.expand_path(@app_root + '/' + file)
+  CONF_FILE = './.app_stack.yml'
 
-        if @files[file] == '__self' # don't handle it
-          carp "From #{app.blue.bold} #{file.bold}",
-               'skip, use '.white + @files[file], 2
-        else # not registered as self, copy over
-          unless @files[file] == app
-            carp "By #{app.bold.blue}, overwrite #{@files[file].bold} #{file}",
-                 'ok'.green, 1 if @files[file]
-            @files[file] = app
-          end
 
-          if File.exists?(src_f + @config['tpl_ext'])
-            carp "From #{app.blue.bold} render #{file.bold}",
-                 render_file!(src_f + @config['tpl_ext'], tgt_f), 1
-
-          else
-            carp "From #{app.blue.bold} copy #{file.bold}",
-                 copy_file!(src_f, tgt_f), 1
-          end
-
-          # register the copied file to app-root file list
-          @self_files << file unless @self_files.include?(file)
-        end
-      end
-    end
-  end
-
-  # print debug / information message to console based on verbose level
-  def carp(job, state = 'done'.green, v = 1)
-    return if @verbose < v
-    dots = 70 - job.size
-    job += ' ' + '.' * dots if dots > 0
-    puts job + ' ' + state
-  end
-
-  # fetch (and cache) git ignore file lists for a specific directory
-  def gitignore_list(dir)
-    @gitignore_list ||= {}
-    @gitignore_list[dir] ||= []
-
-    ilist = []
-    if File.exists?(dir + '/.gitignore')
-      File.read(dir + '/.gitignore').split("\n").each do |line|
-        Dir[dir + '/' + line].each do |f|
-          fn = f.sub(/^#{dir}\//, '')
-          ilist << fn unless ilist.include?(fn)
-        end
-      end
-    end
-    @gitignore_list[dir] = ilist
-  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
-
-  # find a list of file to copy based on export setting
-  def export_list(dir, groups = ['default'])
-    dir_conf = YAML.load(File.read(dir + '/' + File.basename(@conf_file)))
-    dir_conf['export'] ||= []
-    dir_conf['exclude'] ||= []
-
-    # update attr list for assign to template files
-    @attrs.deep_merge! dir_conf['attrs'] if dir_conf['attrs'] &&
-                                           dir_conf['attrs'].is_a?(Hash)
-
-    group_patterns, flist = { 'default' => [] }, []
-    # export list defined in stack app's configuration
-    dir_conf['export'].each do |e|
-      if e.is_a?(Hash)
-        e.each { |k, v| group_patterns[k] = v }
-      else
-        group_patterns['default'] << e
-      end
-    end
-
-    group_patterns.each do |k, v|
-      raise "file for group #{k} is not a array." unless v.is_a?(Array)
-      next unless groups.include?(k) || groups.include?('all')
-      v.each do |e|
-        Dir[dir + '/' + e].each do |f|
-         fn = f.sub(/^#{dir}\/?/, '')
-         flist << fn unless flist.include?(fn)
-        end
-      end
-    end
-
-    exc_list = []
-    dir_conf['exclude'].each do |exc|
-      Dir[dir + '/' + exc].each do |f|
-        fn = f.sub(/^#{dir}\/?/, '')
-        exc_list << fn unless exc_list.include?(fn)
-      end
-    end
-
-    # adjust by include/exclude and
-    flist - gitignore_list(dir) - exc_list
-  end
-
-  # copy file if newer
-  def copy_file!(f, target)
-    # directory?
-    if File.directory?(f)
-      if File.directory?(target)
-        done = 'exists'.green
-      else
-        FileUtils.mkdir_p target
-        done = 'created'.bold.green
-      end
-    else
-      if newer?(f, target)
-        target_dir = File.dirname(target)
-        FileUtils.mkdir_p target_dir unless File.directory?(target_dir)
-        FileUtils.copy f, target
-        done = 'copied'.bold.green
-      else
-        done = 'keep'.white
-      end
-    end
-    done
-  end
-
-  # render from erb if newer
-  def render_file!(f, target)
-    done = 'keep'.white
-    # unless newer?(target, f)
-    tilt = Tilt::ERBTemplate.new(f)
-    oh = File.open(target, 'wb')
-    oh.write tilt.render(OpenStruct.new(@attrs.deep_merge(@config['attrs'])))
-    oh.close
+  # 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)
 
-    # update template timestamp
-    FileUtils.touch(f)
-    done = 'rendered'.bold.green
-    # end
-    # done
+    # not run, just prepare in vobose mode
+    ENV['NR'] ? mger.prepare(true) : mger.merge!
   end
 
-  # use module variables, skip `new`
-  # rubocop:disable ModuleFunction
-  extend self
+  module_function :stackup!
 end

data/spec/config_spec.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe AppStack::Config do
+  context 'raise parse errors' do
+    it 'for unkown keys' do
+      expect do
+        AppStack::Config.new('spec/fixtures/config_sample/wrong_key.yml')
+      end.to raise_error(AppStack::ParseError)
+    end
+
+    it 'for wrong data types' do
+      expect do
+        AppStack::Config.new('spec/fixtures/config_sample/wrong_type.yml')
+      end.to raise_error(AppStack::ParseError)
+    end
+  end
+
+  context 'load configuration' do
+    subject :config do
+      AppStack::Config.new('spec/fixtures/config_sample/sample.yml')
+    end
+
+    it 'for default' do
+      config.stack_dir.should eq(File.expand_path('spec/fixtures'))
+    end
+
+    it 'set new value' do
+      config.attrs['outer'][0]['inter']['some_key'].should eq('some_value')
+    end
+  end
+
+  context 'read properties' do
+    subject :config do
+      AppStack::Config.new('spec/fixtures/sample_files/my_app/app_stack.yml')
+    end
+
+    it '#directory' do
+      dir = File.expand_path('./spec/fixtures/sample_files/my_app')
+      config.directory.should eq(dir)
+    end
+
+    it '#filename' do
+      file = File.expand_path('./spec/fixtures/sample_files/my_app/app_stack.yml')
+      config.filename.should eq(file)
+    end
+
+    it '#app_name' do
+      config.app_name.should eq('my_app')
+    end
+  end
+
+  describe '#export_files' do
+    subject(:conf) { AppStack::Config.new('spec/fixtures/sample_files/module_1/app_stack.yml') }
+    it 'default file list' do
+      %w[mixins/b_lib.rb mixins/s_lib.rb samples/a_lib.rb].each do |fb|
+        file = File.expand_path('./spec/fixtures/sample_files/module_1/lib/' + fb)
+        conf.export_files[file].should eq('/lib/' + fb)
+      end
+    end
+
+    it 'load group files' do
+      file = File.expand_path('./spec/fixtures/sample_files/module_1/spec/config_spec.rb')
+      conf.export_files('tests')[file].should eq('/spec/config_spec.rb')
+    end
+
+    it 'file mapping hash' do
+      file = File.expand_path('./spec/fixtures/sample_files/module_1/config/boot_sample.rb')
+      conf.export_files('config')[file].should eq('/config/boot.rb')
+    end
+  end
+
+  describe 'other file lists' do
+    subject(:conf) { AppStack::Config.new('spec/fixtures/sample_files/my_app/app_stack.yml') }
+    it '#exclude_list' do
+      file = File.expand_path('./spec/fixtures/sample_files/my_app/doc/excluding.txt')
+      conf.exclude_files[file].should eq('/doc/excluding.txt')
+      p conf.export_files('config')
+    end
+
+  end
+end

data/spec/fixtures/config_sample/sample.yml

@@ -0,0 +1,19 @@
+stack:
+  - mod_a
+  - mod_b:
+    - file_a
+    - file_b: file_b_target
+export:
+  - Rakefile
+  - tests:
+    - spec/**/*
+  - others:
+    - Gemfile
+    - Procfile
+exclude:
+  - exclude_me
+attrs:
+  outer:
+  - inter:
+      some_key: some_value
+

data/spec/fixtures/config_sample/wrong_key.yml

@@ -0,0 +1,2 @@
+stack: []
+dir_name: '-'

data/spec/fixtures/config_sample/wrong_type.yml

@@ -0,0 +1 @@
+stack: {}

data/spec/fixtures/sample_files/module_1/Gemfile.erb

@@ -0,0 +1 @@
+Mod1: <%= application_code %>

data/spec/fixtures/sample_files/module_1/app_stack.yml

@@ -0,0 +1,10 @@
+export:
+- lib/**/*.rb
+- doc/**/*
+- Gemfile
+- Rakefile
+- tests:
+  - spec/**/*_spec.rb
+- config:
+  - config/boot_sample.rb: config/boot.rb
+

data/spec/fixtures/sample_files/module_1/doc/excluding.txt

@@ -0,0 +1 @@
+from module1

data/spec/fixtures/sample_files/module_2/Gemfile.liquid

@@ -0,0 +1 @@
+Mod2: {{ application_code }}

data/spec/fixtures/sample_files/module_2/app_stack.yml

@@ -0,0 +1,3 @@
+export:
+- app/**/*.rb
+- Gemfile