fedux_org-stdlib 0.6.47 → 0.6.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ece173128292a383a56c8d916b0e6aae47d5961
-  data.tar.gz: f16e7f741547036b3bd0d60a9e8d623c602305d7
+  metadata.gz: 83b6bcc48108fd4ffbf7271496c08875e9fd8b38
+  data.tar.gz: 90370b2ddcdad236c1fe53915cdafa781c4aea3b
 SHA512:
-  metadata.gz: b2362f46430bb0e926f7448b0cb2ec667b5d5b3a0514043a2ff189acdeb99467c14cce5f54ebce49c238961e0fd340fe83a59cf82a3ee79b8b51f134241ba0ed
-  data.tar.gz: 85003a967218a9b182866e75f716f8b8e4d556c1f12f21714b0ee970401c4260cd52a8884bf8859add1009dc0e9c8af88db9bc8f272c1742c99a6cc521e63d23
+  metadata.gz: 73b8bbf86f9aa7c5be2e757882af824c831d3cbfa9f2400dfa8cbe14b8b607f711491843b9a65c16709358ec3c9a7dec1bd37ee56047d7ee65b2d09a6b7a0dee
+  data.tar.gz: f564ed4e1960a030b77a0006b393af5e7ec966ba87fd46a162e03470bbb7c8df0930a4d757b3361757c5a0a53a95205aaf433b3b2dfd02d8def8c6966a30bf74

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fedux_org-stdlib (0.6.46)
+    fedux_org-stdlib (0.6.47)
       activesupport
 
 GEM

data/lib/fedux_org_stdlib/file_template.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
 require 'fedux_org_stdlib/file_template/exceptions'
-require 'fedux_org_stdlib/core_ext/array'
+require 'fedux_org_stdlib/core_ext/array/list'
 require 'fedux_org_stdlib/logging/logger'
 require_library %w{ json active_support/core_ext/string/inflections }
 

data/lib/fedux_org_stdlib/template_directory.rb

@@ -0,0 +1,197 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/require_files'
+require 'fedux_org_stdlib/template_directory/exceptions'
+require 'fedux_org_stdlib/core_ext/array/list'
+require 'fedux_org_stdlib/logging/logger'
+require_library %w{ json active_support/core_ext/string/inflections }
+
+module FeduxOrgStdlib
+  # This class makes a template file available as an object. You can use
+  # whatever template language you prefer. It's up to you to compile the
+  # template with a suitable template parser.
+  #
+  # By default it will look for a suitable template file in the given order:
+  #
+  # 1. <current working directory>/templates/<template_directory>
+  # 2. $HOME/.config/<application_name>/templates/<template_directory>
+  # 3. $HOME/.<application_name>/templates/<template_directory>
+  # 4. /etc/<application_name>/templates/<template_directory>
+  #
+  # Please keep in mind
+  #
+  # * application_name: Module of your class, e.g. "MyApplication" becomes
+  #   "my_application"
+  # * template_directory: Plural name of your class and "TemplateDirectory" strip
+  #   off, e.g "ClientTemplateDirectory" becomes "clients.d"
+  #
+  # Most conventions defined by me are implemented as separate methods. If one convention
+  # is not suitable for your use case, just overwrite the method. 
+  #
+  # If you prefer to use a different path to the template file or name of the
+  # template file one of the following methods needs to be overwritten:
+  #
+  # * template_directory
+  # * template_directory_basename
+  # * application_name
+  #
+  # If you want the class to look for your template file at a different place
+  # overwrite the following method
+  #
+  # * allowed_template_directory_paths
+  #
+  # Below you find some examples for the usage of the class:
+  #
+  # @example Create template with one writer and reader
+  #   module MyApplication
+  #     class ClientTemplateDirectory < FileTemplate
+  #     end
+  #   end
+  class TemplateDirectory
+
+    attr_reader :working_directory, :logger, :directory, :template_files
+
+    # Create a new instance of template
+    #
+    # It tries to find a suitable template directory. If it doesn't find one
+    # the template is empty
+    #
+    # @param [String] directory
+    #   Path where template directory is stored.
+    #
+    # @raise [Exceptions::TemplateFileNotReadable]
+    #   If an avaiable template directory could not be read by the template engine
+    #
+    # @return [AppTemplate]
+    #   The template instance. If the resulting data structure created by the
+    #   template_engine does not respond to `:[]` an empty template object will be
+    #   created. 
+    def initialize(
+      directory: nil,
+      logger: FeduxOrgStdlib::Logging::Logger.new,
+      working_directory: Dir.getwd,
+      output_directory: nil
+    )
+      @logger            = logger
+      @working_directory = working_directory
+
+      @directory ||= available_template_directory
+        
+      fail Exceptions::NoTemplateDirectoryFound, "No template directory found at #{allowed_template_directory_paths.to_list}, therefor I'm stop working as there are methods which depend on an available template directory path." unless @directory
+
+      begin
+        @template_files = Dir.glob(File.join(@directory, '**', '*')).keep_if { |o| FileTest.file? o }
+      rescue StandardError => e
+        fail Exceptions::TemplateDirectoryNotReadable, JSON.dump(message: e.message, file: @directory)
+      end
+    end
+
+    # Return the path to the preferred template file
+    # @return [String]
+    #   The path to the preferred template file
+    def preferred_template_directory
+      allowed_template_directory_paths[1]
+    end
+
+    private
+
+    # The name of the template file
+    #
+    # @return [String]
+    #   The name of the template file. It defaults to `<template_directory_basename>.yaml`. If
+    #   you want to use a different file name you need to overwrite this
+    #   method.
+    def template_directory
+      "#{template_directory_basename}#{template_directory_suffix}"
+    end
+
+    # The suffix of the template file
+    #
+    # @return [String]
+    #   The suffix of the template file
+    def template_directory_suffix
+      '.d'
+    end
+
+    # The base name of the template
+    #
+    # @return [String]
+    #   This one returns the base name of the template file (without the file
+    #   extension). It uses the class name of the template class
+    #
+    # @example Determine the base name of the template
+    #
+    #   class ClientTemplate; end
+    #
+    # This will result in `client` as base name for the template file.
+    def template_directory_basename
+      unless (name = class_name.sub(/TemplateDirectory/, '').underscore.pluralize).blank?
+        return name
+      end
+
+      fail Exceptions::ClassNameIsMissing, JSON.dump(klass: class_name)
+    end
+
+    # The name of your application
+    #
+    # @return [String]
+    #  This will strip of the class part of fully qualified class name and
+    #  converted it to a path.
+    #
+    # @example Determine application name
+    #
+    #   class MyApplication::MyTemplate; end
+    #
+    # This will be converted to
+    #
+    #    my_application
+    def application_name
+      module_name.underscore
+    end
+
+    # The paths where to look for the template file
+    #
+    # @return [Array]
+    #   A list of paths where the template object should look for its template
+    #   file.
+    def allowed_template_directory_paths
+      paths = []
+
+      paths << resolve_path(working_directory, 'templates', template_directory)
+      paths << resolve_path('~', '.config', application_name, 'templates', template_directory)
+      paths << resolve_path('~', format('.%s', application_name), 'templates', template_directory)
+      paths << resolve_path('/etc', application_name, 'templates', template_directory)
+      paths << resolve_path(fallback_template_directory, template_directory) if fallback_template_directory
+
+      paths
+    end
+
+    def resolve_path(*path)
+      ::File.expand_path(::File.join(*path))
+    end
+
+
+    # Use this path as fall back path
+    def fallback_template_directory; end
+
+    def class_name
+      self.class.name.to_s.demodulize
+    end
+
+    def module_name
+      self.class.to_s.deconstantize
+    end
+
+    def available_template_directory
+      allowed_template_directory_paths.each do |p|
+        object = Dir.glob("#{p}/**/*").keep_if { |o| ::FileTest.file?(o) }.first
+
+        next if object.blank?
+        return p if object
+      end
+    end
+
+    def self.reserved_key_words
+      (methods | instance_methods | private_methods | private_instance_methods ) - (Class.methods | Class.private_methods ) | [:to_s]
+    end
+  end
+end

data/lib/fedux_org_stdlib/template_directory/exceptions.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module FeduxOrgStdlib
+  class TemplateDirectory
+    module Exceptions
+      # Found config file is not readable
+      class TemplateDirectoryNotReadable < StandardError; end
+
+      # No allowed config file could be found
+      class NoTemplateDirectoryFound < StandardError; end
+
+      # If no module is given on class
+      class NamespaceIsMissing < StandardError; end
+
+      # If no class name is present
+      class ClassNameIsMissing < StandardError; end
+
+      # If one tries to define an option name which is forbbiden
+      class OptionNameForbidden < StandardError; end
+    end
+  end
+end

data/lib/fedux_org_stdlib/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 # FeduxOrgStdlib
 module FeduxOrgStdlib
-  VERSION = '0.6.47'
+  VERSION = '0.6.48'
 end

data/spec/template_directory_spec.rb

@@ -0,0 +1,139 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'fedux_org_stdlib/template_directory'
+
+RSpec.describe TemplateDirectory do
+
+  context '#preferred_template_directory' do
+    it 'has a default template file which is the preferred place to store the template' do
+      with_environment 'HOME' => working_directory do
+        create_file '.config/my_application/templates/tests.d/test.tt'
+
+        template_klass = Class.new(TemplateDirectory) do
+          def class_name
+            'TestTemplateDirectory'
+          end
+
+          def module_name
+            'MyApplication'
+          end
+        end
+
+        template = template_klass.new
+        expect(template.preferred_template_directory).to eq File.expand_path('~/.config/my_application/templates/tests.d')
+      end
+    end
+
+    it 'works with nested module names' do
+      with_environment 'HOME' => working_directory do
+        create_file '.config/my_application/my_sub/templates/tests.d/test.tt'
+
+        template_klass = Class.new(TemplateDirectory) do
+          def class_name
+            'TestTemplateDirectory'
+          end
+
+          def module_name
+            'MyApplication::MySub'
+          end
+        end
+
+        template = template_klass.new
+        expect(template.preferred_template_directory).to eq File.expand_path('~/.config/my_application/my_sub/templates/tests.d')
+      end
+    end
+  end
+
+  context 'template files' do
+    it 'looks at ~/.config/my_application/templates/tests.d/test.tt' do
+      with_environment 'HOME' => working_directory do
+        file = create_file '.config/my_application/templates/tests.d/test.tt', <<-EOS.strip_heredoc
+        <%= hello world %>
+        EOS
+
+        template_klass = Class.new(TemplateDirectory) do
+          def class_name
+            'TestTemplateDirectory'
+          end
+
+          def module_name
+            'MyApplication'
+          end
+        end
+
+        template = template_klass.new
+        expect(template.template_files).to include file
+      end
+    end
+
+    it 'looks at ~/.my_application/templates/tests.d/test.tt' do
+      with_environment 'HOME' => working_directory do
+        file = create_file '.my_application/templates/tests.d/test.tt', <<-EOS.strip_heredoc
+        <%= hello world %>
+        EOS
+
+        template_klass = Class.new(TemplateDirectory) do
+          def class_name
+            'TestTemplateDirectory'
+          end
+
+          def module_name
+            'MyApplication'
+          end
+        end
+
+        template = template_klass.new
+        expect(template.template_files).to include file
+      end
+    end
+
+    it 'returns templates in subdirectories as well' do
+      with_environment 'HOME' => working_directory do
+        file = create_file '.my_application/templates/tests.d/blub/test.tt', <<-EOS.strip_heredoc
+        <%= hello world %>
+        EOS
+
+        template_klass = Class.new(TemplateDirectory) do
+          def class_name
+            'TestTemplateDirectory'
+          end
+
+          def module_name
+            'MyApplication'
+          end
+        end
+
+        template = template_klass.new
+        expect(template.template_files).to include file
+      end
+    end
+  end
+
+  context '#template_files' do
+    it 'returns template_files in template directory' do
+      with_environment 'HOME' => working_directory do
+        file1 = create_file '.my_application/templates/tests.d/test1.tt', <<-EOS.strip_heredoc
+        <%= hello world %>
+        EOS
+
+        file2 = create_file '.my_application/templates/tests.d/test2.tt', <<-EOS.strip_heredoc
+        <%= hello world %>
+        EOS
+
+        template_klass = Class.new(TemplateDirectory) do
+          def class_name
+            'TestTemplateDirectory'
+          end
+
+          def module_name
+            'MyApplication'
+          end
+        end
+
+        template = template_klass.new
+        expect(template.template_files).to include file1
+        expect(template.template_files).to include file2
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.6.47
+  version: 0.6.48
 platform: ruby
 authors:
 - Max Meyer
@@ -126,6 +126,8 @@ files:
 - lib/fedux_org_stdlib/require_files.rb
 - lib/fedux_org_stdlib/shell_language_detector.rb
 - lib/fedux_org_stdlib/shell_language_detector/language.rb
+- lib/fedux_org_stdlib/template_directory.rb
+- lib/fedux_org_stdlib/template_directory/exceptions.rb
 - lib/fedux_org_stdlib/version.rb
 - lib/fedux_org_stdlib/version_management/exceptions.rb
 - lib/fedux_org_stdlib/version_management/library_builder.rb
@@ -179,6 +181,7 @@ files:
 - spec/support/reporting.rb
 - spec/support/rspec.rb
 - spec/support/string.rb
+- spec/template_directory_spec.rb
 - spec/template_file_spec.rb
 - spec/version_management/library_builder_spec.rb
 - spec/version_management/ruby_library_spec.rb
@@ -251,6 +254,7 @@ test_files:
 - spec/support/reporting.rb
 - spec/support/rspec.rb
 - spec/support/string.rb
+- spec/template_directory_spec.rb
 - spec/template_file_spec.rb
 - spec/version_management/library_builder_spec.rb
 - spec/version_management/ruby_library_spec.rb