ashiba 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64048ef4dbc11eb3f67c0a55e952447ae308dc3196fbb641d41e2ce72ab98b6d
+  data.tar.gz: a42654dbf742cb324c5d8e998cb66069a08b355dfdee168307ca3248471f97eb
+SHA512:
+  metadata.gz: cfc6ac7386b25658590c49e39ada2e86b988779e2c2516892fabbf2a1932b8d8fe5173594f6d2283b89af8a9bac84d9ef60703e2c25346cd9b24baa59835943e
+  data.tar.gz: 3acfdf76ec99472fa438ec8a857f5bc635ccc33052f7a0a1229d39fa80ca0d3b7355ba4993abccf322a10d1e0be4b7c75260a8b1cae17b7188218cabf8b2eca5

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## Unreleased
+
+## Version 0.8.0
+
+- Update minimum ruby version to 2.7
+- Add GitHub Workflows
+
+## Version 0.7.0
+
+- Add ability to run commands at the end
+- Add bump, editorconfig and overcommit
+
+## Version 0.6.0
+
+- First public release

data/README.md

@@ -0,0 +1,77 @@
+# Ashiba
+
+Ashiba is yet another Ruby-based scaffolding tool. It allows bootstrapping of
+projects using precreated templates. Templates for projects can be authored
+as separate Rubygems to allow maximum flexibility and central management.
+
+Ashiba (足場) is Japanese for scaffolding and meand as a nod towards the
+Ruby language, which originated in Japan.
+
+## Installation
+
+Install the tool with
+
+```bash
+gem install 'ashiba'
+```
+
+## Template Authoring
+
+A generator for templates is included under the name `ashiba-template`. With
+this, you can create you own custom generators for Rubygems, Chef Cookbooks
+or whatever you want.
+
+Every template has a configuration file in YAML which states some metadata
+along with the template's variables and their defaults like this:
+
+```yaml
+variables:
+  name: ''
+  version: 0.1.0
+```
+
+All files within a template are parsed as ERB, so you can substitute
+things with variables (`<%= name + ' ' + version %>`) or execute Ruby code for
+looping or anything else (`<% do_something() %>`).
+
+If you want to use the content of a variable in a filename, just enclose it in
+percent signs: `%name%.gemspec`.
+
+All templates are directly configured as Gem file, so you can build them,
+install them and even publish them to your own private Gem repository or
+rubygems.org.
+
+### Final commands
+
+If you want commands to be executed after scaffolding your project, add them as
+a list under the `finalize` key of the YAML
+
+## Configuration
+
+Ashiba YAML configuration files reside in ~/.ashibarc or in /etc/ashiba/ashibarc.
+
+You currently can only override template defaults with a file like
+
+```yaml
+author: My Name
+email: name@example.com
+```
+
+which will override the author/email variable defaults from the template. So if
+you have this in your home directory or the system configuration directory,
+all template executions will default to your name and email.
+
+## Usage
+
+`ashiba help` Display all available commands
+
+`ashiba list` List all available templates on the system
+
+`ashiba info TEMPLATE` Display metadata about a template
+
+`ashiba create TEMPLATE PATH [--set variable:value]` Scaffold a package
+Note that you can manually specify contents of variables. Lookup will happen
+in order `/etc/ashiba/ashibarc`, `~/.ashibarc`, `--set` value or template
+default.
+
+`ashiba version` Output version of Ashiba

data/bin/ashiba

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'ashiba'
+
+Ashiba::Cli.start

data/lib/ashiba/cli.rb

@@ -0,0 +1,236 @@
+require 'hashie'
+require 'highline'
+require 'thor'
+require 'yaml'
+
+module Ashiba
+  class TemplateVariable
+    attr_accessor :name, :value, :type, :default, :mandatory
+
+    # ok this is bugged
+    def initialize(name = '', value = '', type = 'String', default = '', mandatory = false)
+      @name = name
+      @value = value
+      @type = type
+      @default = default
+      @mandatory = mandatory
+    end
+
+    def to_s
+      "#{name}=#{value} of type #{type}, defaulting to #{default} and mandatory is #{mandatory}"
+    end
+  end
+
+  class Cli < Thor
+    include Thor::Actions
+    check_unknown_options!
+    # add_runtime_options!
+
+    def self.source_root
+      # File.dirname(__FILE__)
+      File.expand_path('../../templates', __dir__)
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    map %w[version] => :__print_version
+    desc 'version', 'Display version'
+    def __print_version
+      say "Ashiba #{VERSION} (Ruby #{RUBY_VERSION}-#{RUBY_PLATFORM})"
+    end
+
+    @packdata = {}
+    attr_accessor :packdata
+
+    @config = {}
+    attr_accessor :config
+
+    no_commands do
+      def get_data_from_template(name)
+        TemplateLoader.new.load_template(name)
+      end
+
+      def load_data_from_userconfig
+        @config = Configuration.new
+        @config.load
+      end
+
+      # @todo
+      @template_information = {}
+      def process_template_information(template)
+        template_info = get_data_from_template(template)
+        template_info = template_info.delete('variables')
+        @template_information = Hashie::Mash.new(template_info)
+      end
+
+      def template_information(key)
+        @template_information.fetch(key)
+      end
+
+      # @todo
+      @template_variables = {}
+      def process_template_variables(_template, variables)
+        # template_info = get_data_from_template(template)
+        # @todo unifying structure, ideally struct class?
+        # variables = Hashie::Mash.new(template_info['variables'])
+        variables = Hashie::Mash.new(variables)
+
+        variables.each do |k, v|
+          if v.is_a?(String)
+            TemplateVariable.new(name: k, value: v)
+            # Results in #<struct TemplateVariable name={:name=>"email", :value=>"theinen@tecracer.de"}, value=""
+          elsif v.is_a?(Hashie::Mash)
+            # puts TemplateVariable.new(name: k, **v)
+            # Explodes like a Pro
+          else
+            raise "No known datatype for variable #{k}"
+          end
+        end
+      end
+
+      def parse_template_data(template)
+        template_info = get_data_from_template(template)
+
+        # Template defaults, then config files, then command line
+        defaults = Hashie::Mash.new(template_info['variables'])
+        defaults.deep_update(load_data_from_userconfig)
+        defaults.deep_update(options['set'])
+
+        # For ease of use: if no 'name' was passed, use the directory name
+        defaults['name'] = File.basename(@path) if defaults['name'].empty?
+
+        # Command line query of mandatory arguments
+        cli = HighLine.new
+        used_cli = false
+        defaults.each do |parameter, data|
+          next unless data == :mandatory
+
+          puts 'Unset parameters' unless used_cli
+
+          defaults[parameter] = cli.ask("  #{parameter}: ")
+          used_cli = true
+        end
+        if used_cli
+          puts 'Evaluated parameters:'
+          defaults.each { |k, v| puts "  #{k}: #{v}" }
+
+          exit unless yes?('Create? [Y/N]')
+        end
+
+        process_template_information(template)
+        process_template_variables(template, defaults)
+
+        @packdata = defaults
+      end
+
+      def retrieve_value(name)
+        packdata.fetch(name)
+      end
+
+      def dest_filename(filename)
+        new_filename = filename.dup
+        filename.scan(/%.+?%/) do |placeholder|
+          variable = placeholder[1..-2]
+          new_filename.gsub!(placeholder, retrieve_value(variable))
+        end
+
+        new_filename
+      end
+
+      def copy_template(template, path)
+        # @todo Really confusing
+        template_base = TemplateLoader.new.search_template(template).gsub(/\.yaml$/, '')
+
+        entries = Dir.glob("#{template_base}/**/*", File::FNM_DOTMATCH) - %w[. ..]
+        entries.select! { |entry| File.file?(entry) }
+        entries.map! { |entry| entry.gsub("#{template_base}/", '') }
+
+        entries.each do |name|
+          template("#{template_base}/#{name}", "#{path}/#{dest_filename(name)}")
+        end
+
+        template_info = get_data_from_template(template)
+        finalize = Array(template_info['finalize'])
+        return unless finalize
+
+        Dir.chdir(path) do
+          finalize.each { |cmd| puts `#{cmd}` }
+        end
+      end
+
+      # rubocop:disable Style/MethodMissingSuper,Style/MissingRespondToMissing
+      def method_missing(method, *_args, &_block)
+        packdata.fetch(method)
+      end
+      # rubocop:enable Style/MethodMissingSuper,Style/MissingRespondToMissing
+    end
+
+    desc 'create TEMPLATE PATH', 'Scaffold a new path'
+    method_option :set, desc: 'Values of template to set', type: :hash, default: {}
+    def create(template, path)
+      path = File.expand_path(path)
+      raise Error, set_color("ERROR: #{path} already exists.", :red) if File.exist?(path)
+
+      @path = path
+      parse_template_data(template)
+      copy_template(template, path)
+    end
+
+    desc 'list', 'List available templates'
+    def list
+      # @todo Should be in TemplateLoader
+      dirs = TemplateLoader.new.locations
+      entries = []
+      dirs.each do |dir|
+        yamls = Dir.glob('*.yaml', base: dir)
+        basenames = yamls.map { |filename| filename.gsub(/\.yaml$/, '') }
+
+        entries.concat(basenames)
+      end
+
+      say 'Available templates:'
+      entries.uniq.sort.each do |template|
+        data = get_data_from_template(template)
+        say "  #{data['name']} (#{data['version']}) - #{data['summary']}"
+      end
+    end
+
+    desc 'locations', 'List locations to load templates from'
+    def locations
+      dirs = TemplateLoader.new.locations
+
+      say 'Locations searched for templates'
+      dirs.each do |dir|
+        say "  #{dir}"
+      end
+    end
+
+    desc 'info TEMPLATE', 'Get information about a template'
+    def info(template)
+      load_data_from_userconfig
+
+      template_info = get_data_from_template(template)
+      output = <<~OUTPUT
+        Name       : #{template_info['name']}
+        Version    : #{template_info['version']}
+        Description: #{template_info['description'].chop}
+        Origin     : #{template_info['origin']}
+
+        Variables:
+      OUTPUT
+      say output
+
+      align_to = template_info['variables'].keys.map(&:length).max # { |item| item.length }.max
+      template_info['variables'].each do |name, default|
+        default = '<unset>' if default.empty? || default == :mandatory
+
+        outline =  "  #{name.ljust(align_to)}: "
+        outline << "#{@config.settings[name]} (was: #{default})" if config.settings[name]
+        outline << default unless config.settings[name]
+        say outline
+      end
+    end
+  end
+end

data/lib/ashiba/configuration.rb

@@ -0,0 +1,70 @@
+require 'hashie'
+require 'yaml'
+
+# Namespace of Ashiba
+module Ashiba
+  # Class loading and representing all configuration data independent
+  # of chosen templates
+  #
+  # @attr [Hashie::Mash] settings Loaded settings
+  class Configuration
+    attr_accessor :settings
+
+    # Initialize class
+    def initialize
+      @settings = Hashie::Mash.new
+    end
+
+    # Return all locations to look for configuration files.
+    #
+    # @return [Array] Possible paths for configuration
+    def locations
+      [
+        '/etc/ashiba/fashibarc',
+        "#{ENV['HOME']}/.ashibarc"
+      ]
+    end
+
+    # Load values from stated file and merge over previously loaded data,
+    # allowing stacking of global + personal configuration
+    #
+    # @param [String] filename
+    # @return [void]
+    def process_config(file)
+      $logger.debug("Processing user configuraton file #{file}")
+
+      begin
+        contents = ::YAML.load_file(file)
+      rescue Errno::ENOENT => e
+        puts e.message
+      rescue ::YAML::SyntaxError => e
+        puts e.message
+      end
+
+      new_settings = Hashie::Mash.new(contents)
+      new_settings.each { |k, v| $logger.debug("  Setting #{k} to #{v}") }
+
+      @settings.deep_merge!(new_settings)
+    end
+
+    # Recurse over possible locations for configuration and stack found
+    # values
+    #
+    # @return [Hash] Summary of settings
+    def load
+      $logger.info('Loading configuration')
+
+      locations.each do |config|
+        $logger.debug("Checking for configuration at #{config}")
+        next unless File.file?(config)
+
+        process_config(config)
+      end
+
+      $logger.debug('Evaluated configuration as:')
+      @settings.each { |k, v| $logger.debug("  Setting #{k} to #{v}") }
+
+      @settings.to_hash # @todo just for compatibility with old codebase
+    end
+  end
+end

data/lib/ashiba/logger.rb

@@ -0,0 +1,5 @@
+require 'logger'
+
+$logger = Logger.new(STDOUT)
+$logger.level = Logger::WARN
+$logger.info('Starting Ashiba')

data/lib/ashiba/template.rb

@@ -0,0 +1,9 @@
+# This is the Ashiba namespace
+module Ashiba
+  attr_accessor :name, :version, :summary, :description, :author
+  # @todo: Variables
+
+  class Template
+    # Work in progress
+  end
+end

data/lib/ashiba/template_loader.rb

@@ -0,0 +1,71 @@
+require 'yaml'
+# require_relative 'template_loaders/*.rb'
+
+# Namespace of Ashiba
+module Ashiba
+  # Loads templates and creates the Template object.
+  class TemplateLoader
+    # Return all locations to look for configuration files.
+    #
+    # @return [Array] Possible paths for configuration
+    def locations
+      dirs = []
+
+      # Add any templates in plugin packs
+      template_gems = Gem::Specification.latest_specs(true).select { |g| g.name =~ /^ashiba-/ }
+      template_gems.each do |spec|
+        dirs << File.join(spec.base_dir, 'gems', "#{spec.name}-#{spec.version}", 'templates')
+      end
+
+      # Bundled templates last, so they can be overridden by identically named gems
+      dirs << File.expand_path('../../templates', __dir__)
+    end
+
+    # Search for given template in all known locations. May be
+    # given a path as well, to directly reference a file
+    #
+    # @param [String] Name/Path of template
+    # @return [String] Full path of the template, if found
+    # @raise [SomeError] If no template could be found
+    def search_template(name)
+      return name if File.file?(name)
+
+      locations.each do |path|
+        expected = "#{path}/#{name}.yaml"
+        return expected if File.file?(expected)
+      end
+
+      raise "Template #{name} not found. Search path: #{locations.join(', ')}"
+    end
+
+    # Load the template, including a search in all known locations
+    # for templates
+    #
+    # @param [String] Name/Path of the template
+    # @return [Hash] Configuration data, only for compatibility reasons
+    # @raise [Error] If file was not found
+    # @raise [YAML::SyntaxError] If file was invalid
+    def load_template(name)
+      config_file = search_template(name)
+
+      begin
+        contents = ::YAML.load_file(config_file)
+      rescue Errno::ENOENT => e
+        puts e.message
+      rescue ::YAML::SyntaxError => e
+        puts e.message
+      end
+
+      # @todo Only for compatibility reasons, should use regular getters later
+      contents['origin'] = config_file
+      contents
+
+      # @_contents = contents
+      # return template
+    end
+
+    def template
+      Template.new(@_contents)
+    end
+  end
+end

data/lib/ashiba/version.rb

@@ -0,0 +1,3 @@
+module Ashiba
+  VERSION = '0.7.0'.freeze
+end

data/lib/ashiba.rb

@@ -0,0 +1,6 @@
+require 'ashiba/logger'
+require 'ashiba/template'
+require 'ashiba/template_loader'
+require 'ashiba/configuration'
+require 'ashiba/cli'
+require 'ashiba/version'

data/templates/ashiba-template/%name%.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |spec|
+  spec.name        = '<%= name %>'
+  spec.version     = '<%= version %>'
+  spec.licenses    = ['Nonstandard']
+
+  spec.summary     = '<%= summary %>'
+  spec.description = '<%= description %>'
+  spec.authors     = ['<%= author %>']
+  spec.email       = ['<%= email %>']
+  spec.homepage    = '<%= url %>'
+
+  spec.files       = Dir.glob('templates/**/**', File::FNM_DOTMATCH)
+  spec.files      += ['README.md', 'CHANGELOG.md']
+
+  spec.required_ruby_version = '>= 2.4'
+
+  spec.add_runtime_dependency('ashiba', '>= 0.5')
+end

data/templates/ashiba-template/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Version <%= version %>
+
+- Initial version

data/templates/ashiba-template/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in its .gemspec
+gemspec

data/templates/ashiba-template/README.md

@@ -0,0 +1,5 @@
+# <%= name %>
+
+## Summary
+
+<%= summary %>

data/templates/ashiba-template/Rakefile

@@ -0,0 +1,17 @@
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+
+Rake::Task["release"].clear
+
+# We run tests by default
+task :default => :build
+task :gem => :build
+
+#
+# Install all tasks found in tasks folder
+#
+# See .rake files there for complete documentation.
+#
+Dir["tasks/*.rake"].each do |taskfile|
+  load taskfile
+end

data/templates/ashiba-template/tasks/gem.rake

@@ -0,0 +1,27 @@
+# Installs rake tasks for gemming and packaging
+#
+begin
+  require 'rubygems/package_task'
+
+  CLEAN.include('pkg/*')
+  CLEAN.include('doc/*')
+
+  # Dynamically load the gem spec
+  filename     = '../../' + Dir.glob('*.gemspec').first
+  gemspec_file = File.expand_path(filename, __FILE__)
+  gemspec      = Kernel.eval(File.read(gemspec_file))
+
+  Gem::PackageTask.new(gemspec) do |t|
+    t.name = gemspec.name
+    t.version = gemspec.version
+    t.package_dir = "pkg"
+    t.package_files = gemspec.files
+  end
+rescue LoadError
+  task :gem do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+  task :package do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+end

data/templates/ashiba-template/templates/example/README.md

@@ -0,0 +1,7 @@
+# <%= name %>
+
+## Summary
+
+<%= summary %>
+
+<%= description %>

data/templates/ashiba-template/templates/example.yaml

@@ -0,0 +1,15 @@
+---
+name: example
+format_version: 1
+version: 0.1.0
+summary: New Ashiba template
+description: |
+  Nothing right now
+variables:
+  name: ''
+  version: 1.0.0
+  author: John Doe
+  email: jdoe@tecracer.de
+  summary: New Template for X
+  description: Provides modular X functionality
+  url: https://tecracer.de

data/templates/ashiba-template.yaml

@@ -0,0 +1,17 @@
+---
+name: ashiba-template
+format_version: 1
+version: 1.0.0
+summary: New Ashiba template
+description: |
+  Creates a template project for new Ashiba templates
+variables:
+  name: ''
+  version: 0.1.0
+  author: John Doe
+  email: john@example.com
+  summary: Summary of the template
+  description: A longer explanation of its functionality
+  url: http://example.com
+finalize:
+  - git init .

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: ashiba
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- Thomas Heinen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: mdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: Use Ashiba to generate directory hierarchies according to templates
+email:
+- theinen@tecracer.de
+executables:
+- ashiba
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- bin/ashiba
+- lib/ashiba.rb
+- lib/ashiba/cli.rb
+- lib/ashiba/configuration.rb
+- lib/ashiba/logger.rb
+- lib/ashiba/template.rb
+- lib/ashiba/template_loader.rb
+- lib/ashiba/version.rb
+- templates/ashiba-template.yaml
+- templates/ashiba-template/%name%.gemspec
+- templates/ashiba-template/CHANGELOG.md
+- templates/ashiba-template/Gemfile
+- templates/ashiba-template/README.md
+- templates/ashiba-template/Rakefile
+- templates/ashiba-template/tasks/gem.rake
+- templates/ashiba-template/templates/example.yaml
+- templates/ashiba-template/templates/example/README.md
+homepage: https://github.com/tecracer/ashiba
+licenses:
+- Apache-2.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Ashiba is another simple scaffolding tool
+test_files: []