fedux_org-stdlib 0.6.22 → 0.6.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22f3a0abb3429c10be240dbdc0a0816c9daf4462
-  data.tar.gz: 8395b4d29686b3cd163acad23457539204295d79
+  metadata.gz: b41b05bdb8bfd2b58cb9934905750b608a6fe1a2
+  data.tar.gz: 9268708b36967f1756ee5131d08e7bffbee32833
 SHA512:
-  metadata.gz: e6449d40125412606f0facdb8b0ae8268b7a9b71de23a3c7ac5f43b4d01e51ac57deb9a1a9073baec6cf347d6c8a252f1ba3b3b83c41f020c66ed509e750659e
-  data.tar.gz: e7be42e048adaa99fb20cc09b494d4c8ee85aa0e8cef35ccd7d0f2698980cda74e5547fdc727d0564fc7013525e3bde8db9c887f698c56a480205db07b939631
+  metadata.gz: fd30198edf16f42727e8cfdd7f5bb1abdf9904d9326366c899c913ac9b154b0fd9779fa4d9003fa305af4c7afbe14419441a65bb143d1fd0191dee8f2806c80c
+  data.tar.gz: 9e04281d393f6fd512335008b11c8514b1b51b315a2b04695bfc371a610888179cd79afeb7957433205ec0c74af03d83a60501577053928626e76720ebae7578

data/Gemfile.lock

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

data/lib/fedux_org_stdlib/file_template.rb

@@ -0,0 +1,193 @@
+# 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/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. $HOME/.config/<application_name>/<template_file>.yaml
+  # 2. $HOME/.<application_name>/<template_file>.yaml
+  # 2. $HOME/.<template_file>.yaml
+  # 2. $HOME/.<template_file>rc
+  # 3. /etc/.<application_name>/<template_file>.yaml
+  #
+  # Please keep in mind
+  #
+  # * application_name: Module of your class, e.g. "MyApplication" becomes
+  #   "my_application"
+  # * template_file: Singular name of your class and "Template" strip
+  #   off, e.g "ClientTemplate" becomes "client.tt"
+  #
+  # 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_file
+  # * template_name
+  # * application_name
+  #
+  # If you want the class to look for your template file at a different place
+  # overwrite the following method
+  #
+  # * allowed_template_file_paths
+  #
+  # Below you find some examples for the usage of the class:
+  #
+  # @example Create template with one writer and reader
+  #   module MyApplication
+  #     class ClientTemplate < FileTemplate
+  #     end
+  #   end
+  #
+  # @example Template yaml file for the classes above: clients.yaml
+  #   <%= hello %>
+  #   ---
+  #   option1: 'data2'
+  class FileTemplate
+    # Create a new instance of template
+    #
+    # It tries to find a suitable template file. If it doesn't find one
+    # the template is empty
+    #
+    # @param [String] file
+    #   Path where template file is stored.
+    #
+    # @raise [Exceptions::TemplateFileNotReadable]
+    #   If an avaiable template file 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(
+      file: _available_template_file, 
+      logger: FeduxOrgStdlib::Logging::Logger.new
+    )
+      @logger = logger
+
+      unless file
+        logger.debug "No template file found at #{_allowed_template_file_paths.to_list}, therefor I'm going to use an empty template object instead." 
+        @__template = ''
+
+        return 
+      end
+
+      begin
+        @__template = File.read(file).chomp
+      rescue StandardError => e
+        fail Exceptions::TemplateFileNotReadable, JSON.dump(message: e.message, file: file)
+      end
+    end
+
+    # Return the path to the preferred template file
+    # @return [String]
+    #   The path to the preferred template file
+    def preferred_template_file
+      _allowed_template_file_paths.first
+    end
+
+    def content
+      @__template
+    end
+
+    private
+
+    # The name of the template file
+    #
+    # @return [String]
+    #   The name of the template file. It defaults to `<template_name>.yaml`. If
+    #   you want to use a different file name you need to overwrite this
+    #   method.
+    def _template_file
+      "#{_template_name}#{_template_file_suffix}"
+    end
+
+    # The suffix of the template file
+    #
+    # @return [String]
+    #   The suffix of the template file
+    def _template_file_suffix
+      '.tt'
+    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_name
+      unless (name = _class_name.sub(/Template/, '').underscore.singularize).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_file_paths
+      paths = []
+      paths << ::File.expand_path(::File.join('~', '.config', _application_name, 'templates', _template_file))
+      paths << ::File.expand_path(::File.join('~', format('.%s', _application_name), 'templates', _template_file))
+      paths << ::File.expand_path(::File.join('/etc', _application_name, 'templates', _template_file))
+      paths << ::File.expand_path(_fallback_template_path) if _fallback_template_path
+
+      paths
+    end
+
+
+    # Use this path as fall back path
+    def _fallback_template_path; end
+
+    def _class_name
+      self.class.name.to_s.demodulize
+    end
+
+    def _module_name
+      self.class.to_s.deconstantize
+    end
+
+    def _available_template_file
+      _allowed_template_file_paths.find { |f| ::File.exists? f }
+    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/file_template/exceptions.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module FeduxOrgStdlib
+  class FileTemplate
+    module Exceptions
+      # Found config file is not readable
+      class TemplateFileNotReadable < StandardError; end
+
+      # No allowed config file could be found
+      class NoTemplateFileFound < 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.22'
+  VERSION = '0.6.23'
 end

data/spec/template_file_spec.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'fedux_org_stdlib/file_template'
+
+RSpec.describe FileTemplate do
+
+  context '#preferred_template_file' do
+    it 'has a default template file which is the preferred place to store the template' do
+      with_environment 'HOME' => working_directory do
+        template_klass = Class.new(FileTemplate) do
+
+          def _class_name
+            'TestTemplate'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        template = template_klass.new
+        expect(template.preferred_template_file).to eq File.expand_path('~/.config/my_application/templates/test.tt')
+      end
+    end
+
+    it 'works with nested module names' do
+      with_environment 'HOME' => working_directory do
+        template_klass = Class.new(FileTemplate) do
+
+          def _class_name
+            'TestTemplate'
+          end
+
+          def _module_name
+            'MyApplication::MySub'
+          end
+        end
+
+        template = template_klass.new
+        expect(template.preferred_template_file).to eq File.expand_path('~/.config/my_application/my_sub/templates/test.tt')
+      end
+    end
+  end
+
+  context 'template files' do
+    it 'looks at ~/.config/my_application/templates/test.tt' do
+      with_environment 'HOME' => working_directory do
+        create_file '.config/my_application/templates/test.tt', <<-EOS.strip_heredoc
+        <%= hello world %>
+        EOS
+
+        template_klass = Class.new(FileTemplate) do
+          def _class_name
+            'TestTemplate'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        template = template_klass.new
+        expect(template.content).to include 'hello world'
+      end
+    end
+
+    it 'looks at ~/.my_application/templates/test.tt' do
+      with_environment 'HOME' => working_directory do
+        create_file '.my_application/templates/test.tt', <<-EOS.strip_heredoc
+        <%= hello world %>
+        EOS
+
+        template_klass = Class.new(FileTemplate) do
+          def _class_name
+            'TestTemplate'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        template = template_klass.new
+        expect(template.content).to include 'hello world'
+      end
+    end
+  end
+
+  context '#content' do
+    it 'returns content of template file' do
+      with_environment 'HOME' => working_directory do
+        create_file '.my_application/templates/test.tt', <<-EOS.strip_heredoc
+        <%= hello world %>
+        EOS
+
+        template_klass = Class.new(FileTemplate) do
+          def _class_name
+            'TestTemplate'
+          end
+
+          def _module_name
+            'MyApplication'
+          end
+        end
+
+        template = template_klass.new
+        expect(template.content).to include 'hello world'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.6.22
+  version: 0.6.23
 platform: ruby
 authors:
 - Max Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -59,6 +59,8 @@ files:
 - lib/fedux_org_stdlib/core_ext/array.rb
 - lib/fedux_org_stdlib/core_ext/string.rb
 - lib/fedux_org_stdlib/environment.rb
+- lib/fedux_org_stdlib/file_template.rb
+- lib/fedux_org_stdlib/file_template/exceptions.rb
 - lib/fedux_org_stdlib/filesystem.rb
 - lib/fedux_org_stdlib/filesystem/exceptions.rb
 - lib/fedux_org_stdlib/logging.rb
@@ -164,6 +166,7 @@ files:
 - spec/support/reporting.rb
 - spec/support/rspec.rb
 - spec/support/string.rb
+- spec/template_file_spec.rb
 - spec/version_management/library_builder_spec.rb
 - spec/version_management/ruby_library_spec.rb
 - spec/version_management/rubygem_version_file_parser_spec.rb
@@ -230,6 +233,7 @@ test_files:
 - spec/support/reporting.rb
 - spec/support/rspec.rb
 - spec/support/string.rb
+- spec/template_file_spec.rb
 - spec/version_management/library_builder_spec.rb
 - spec/version_management/ruby_library_spec.rb
 - spec/version_management/rubygem_version_file_parser_spec.rb