texy 0.8.2 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdca86ea26d9a7605a8f716e8f7278aedd1d8256bb81664c224b6f442f0083ba
-  data.tar.gz: b057845534c305f485cc6e806f1952516d6effa118e4d1a393c6a935e5a7cccb
+  metadata.gz: 22c1b9c891f0747dc3c6a75d99c566e2f8cf0259d6f9451ea6401409e8cdf2f3
+  data.tar.gz: 6d830d3aad5706aa5a8213b265ae39bf24eb83935ba1e11e5638536dc511811e
 SHA512:
-  metadata.gz: a9cc3f2789e889eb4a38213328ceb2c5f8dd3424869e9355d3a6feeab322a77f7864f99fdea1f67ac28de669cdff2c8e032f64e1c80669c92db680366b076be7
-  data.tar.gz: 3cf5432aaf0ff3910d82661392445b8899b8868c1707300887c9403f714cdb744040934c997eb663e18db0677f5b9751cdaa3e7157d703b0c5b377db82e3348a
+  metadata.gz: 02be7094aab23b6308d775b303bc704101a1ad535642937b1cf4c3a08186d9071b4565c83ef959f9cdcdc65e913f5a92740dbaa3c33b35e67fecf9192a2725c0
+  data.tar.gz: 21376883ffe1ea73b79a7a52b3e2eeaf22a9bd4b6510356ff048e0ed47382b441b9218f24ab2b49177158d4e998e19cc5489216836a60c51aaafaf8ef21925dd

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    texy (0.8.2)
+    texy (0.10.2)
       activesupport (~> 6.0)
       thor (~> 0.20.3)
       zeitwerk (~> 2.1)
@@ -9,12 +9,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.2)
+    activesupport (6.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.0)
     coderay (1.1.2)
     concurrent-ruby (1.1.6)

data/lib/texy.rb

@@ -40,19 +40,6 @@ module Texy
       exit
     end
 
-    desc "new-change", "Create a new Change Order"
-    def new_change
-      @repository = Documents::ChangeOrder.repository
-      @object = Documents::ChangeOrder.new
-
-      set_up_environment
-
-      populate_code(object: @object)
-    rescue SystemExit, Interrupt
-      say "Exiting"
-      exit
-    end
-
     desc "new-release-notes", "Create new Release Notes"
     def new_release_notes
       @repository = Documents::ReleaseNotes.repository
@@ -69,7 +56,7 @@ module Texy
     no_commands do
       # Dynamic placeholder file names in the .templates directory allow the object to define the main file's name
       def main_file_name
-        @object.file
+        @object.file_no_extension
       end
     end
 
@@ -77,7 +64,7 @@ module Texy
 
     def populate_code(object:)
       create_folder(folder: object.folder)
-      copy_template_files(template_name: object.type, folder: object.folder, file: object.file)
+      copy_template_files(template_name: object.type, folder: object.folder)
 
       say "Time to populate the LaTeX file..."
 
@@ -89,20 +76,22 @@ module Texy
     def create_folder(folder:)
       say "Creating folder structure..."
 
-      empty_directory folder
+      empty_directory "#{TOP_LEVEL_DIRECTORY}/#{folder}"
 
       say "Folder #{folder} created", :green
     end
 
-    def copy_template_files(template_name:, folder:, file:)
+    def copy_template_files(template_name:, folder:)
       say "Copying template files..."
 
-      directory template_name, folder, recursive: true
+      directory template_name, "#{TOP_LEVEL_DIRECTORY}/#{folder}", recursive: true
 
       say "Template files copied", :green
     end
 
     def push_to_git(branch:)
+      return if ENV["DEBUG"]
+
       say "Ensuring that branch exists..."
 
       unless system_no_output("git rev-parse --verify #{branch}")

data/lib/texy/configuration.rb

@@ -6,7 +6,7 @@ module Texy
     include Thor::Actions
 
     attr_reader :configuration
-    attr_reader :nead_werx
+    attr_reader :company
     attr_reader :client
 
     CONFIGURATION_FILE_NAME = "customers.yml"
@@ -21,8 +21,8 @@ module Texy
         exit
       end
 
-      @nead_werx = Configuration::NeadWerx.new(configuration.dig(:nead_werx))
-      @client    = Configuration::Client.new(configuration.dig(:client))
+      @company = Configuration::Company.new(configuration.dig(:company))
+      @client = Configuration::Client.new(configuration.dig(:client))
     end
   end
 end

data/lib/texy/configuration/client.rb

@@ -23,20 +23,20 @@ module Texy
 
       def extract_people
         @principal = Configuration::Person.new(**configuration.dig(:principal))
-        @signer    = Configuration::Person.new(**configuration.dig(:signer))
+        @signer = Configuration::Person.new(**configuration.dig(:signer))
       end
 
       def extract_rate
-        @rate            = configuration.dig(:rate)
+        @rate = configuration.dig(:rate)
         @rate_multiplier = configuration.dig(:rate_multiplier)
       end
 
       def extract_basic_info
-        @name            = configuration.dig(:name)
-        @short_name      = configuration.dig(:short_name)
-        @abbreviation    = configuration.dig(:abbreviation)
-        @number          = configuration.dig(:number)
-        @system_name     = configuration.dig(:system_name)
+        @name = configuration.dig(:name)
+        @short_name = configuration.dig(:short_name)
+        @abbreviation = configuration.dig(:abbreviation)
+        @number = configuration.dig(:number)
+        @system_name = configuration.dig(:system_name)
       end
     end
   end

data/lib/texy/configuration/{nead_werx.rb → company.rb}

@@ -2,12 +2,12 @@
 
 module Texy
   class Configuration
-    class NeadWerx
+    class Company
       attr_reader :configuration
       attr_reader :principal, :signer
 
-      def initialize(nead_werx_configuration)
-        @configuration = nead_werx_configuration
+      def initialize(company_configuration)
+        @configuration = company_configuration
 
         extract_people
       end
@@ -16,7 +16,7 @@ module Texy
 
       def extract_people
         @principal = Configuration::Person.new(**configuration.dig(:principal))
-        @signer    = Configuration::Person.new(**configuration.dig(:signer))
+        @signer = Configuration::Person.new(**configuration.dig(:signer))
       end
     end
   end

data/lib/texy/document.rb

@@ -13,7 +13,7 @@ module Texy
     def initialize
       @client = ask("Which client folder will this #{type_humanized} be in?", :yellow)
       @number = ask("Which #{type_humanized} number is this?", :yellow).rjust(3, "0")
-      @title  = ask("What is the title of this document?", :yellow)
+      @title = ask("What is the title of this document?", :yellow)
     end
 
     def branch
@@ -24,8 +24,16 @@ module Texy
       "#{client}/#{number}"
     end
 
+    def file_no_extension
+      "#{client}_#{number}"
+    end
+
     def file
-      "#{client}_#{number}.tex"
+      "#{file_no_extension}.tex"
+    end
+
+    def definition_file
+      "lib/commands_and_definitions.tex"
     end
 
     def substitute_placeholders(configuration:)
@@ -37,31 +45,31 @@ module Texy
     # Placeholders dependent on the client configuration
     def config_placeholders
       {
-        /TEMPLATE-PLACEHOLDER-CLIENT-NAME/              => ->(config) { config.client.name },
-        /TEMPLATE-PLACEHOLDER-CLIENT-NUMBER/            => ->(config) { config.client.number },
-        /TEMPLATE-PLACEHOLDER-CLIENT-SHORT-NAME/        => ->(config) { config.client.short_name },
-        /TEMPLATE-PLACEHOLDER-CLIENT-PRINCIPAL-NAME/    => ->(config) { config.client.principal.name },
-        /TEMPLATE-PLACEHOLDER-CLIENT-SIGNER-NAME/       => ->(config) { config.client.signer.name },
-        /TEMPLATE-PLACEHOLDER-CLIENT-SIGNER-ROLE/       => ->(config) { config.client.signer.role },
-        /TEMPLATE-PLACEHOLDER-NEAD-WERX-PRINCIPAL-NAME/ => ->(config) { config.nead_werx.principal.name },
-        /TEMPLATE-PLACEHOLDER-NEAD-WERX-SIGNER-NAME/    => ->(config) { config.nead_werx.signer.name },
-        /TEMPLATE-PLACEHOLDER-NEAD-WERX-SIGNER-ROLE/    => ->(config) { config.nead_werx.signer.role },
+        /TEMPLATE-PLACEHOLDER-CLIENT-NAME/ => ->(config) { config.client.name },
+        /TEMPLATE-PLACEHOLDER-CLIENT-NUMBER/ => ->(config) { config.client.number },
+        /TEMPLATE-PLACEHOLDER-CLIENT-SHORT-NAME/ => ->(config) { config.client.short_name },
+        /TEMPLATE-PLACEHOLDER-CLIENT-PRINCIPAL-NAME/ => ->(config) { config.client.principal.name },
+        /TEMPLATE-PLACEHOLDER-CLIENT-SIGNER-NAME/ => ->(config) { config.client.signer.name },
+        /TEMPLATE-PLACEHOLDER-CLIENT-SIGNER-ROLE/ => ->(config) { config.client.signer.role },
+        /TEMPLATE-PLACEHOLDER-NEAD-WERX-PRINCIPAL-NAME/ => ->(config) { config.company.principal.name },
+        /TEMPLATE-PLACEHOLDER-NEAD-WERX-SIGNER-NAME/ => ->(config) { config.company.signer.name },
+        /TEMPLATE-PLACEHOLDER-NEAD-WERX-SIGNER-ROLE/ => ->(config) { config.company.signer.role }
       }
     end
 
     # Placeholders dependent on this specific document, not the client in general
     def base_placeholders
       {
-        /TEMPLATE-PLACEHOLDER-PROJECT-NUMBER/   => ->(document) { document.number },
-        /TEMPLATE-PLACEHOLDER-PROJECT-TITLE/    => ->(document) { document.title },
-        /TEMPLATE-PLACEHOLDER-DOCUMENT-VERSION/ => ->(_document) { "1.0" },
+        /TEMPLATE-PLACEHOLDER-PROJECT-NUMBER/ => ->(document) { document.number },
+        /TEMPLATE-PLACEHOLDER-PROJECT-TITLE/ => ->(document) { document.title },
+        /TEMPLATE-PLACEHOLDER-DOCUMENT-VERSION/ => ->(_document) { "1.0" }
       }
     end
 
     # Placeholders located in the index file, not the LaTeX file
     def index_file_placeholders
       {
-        /TEMPLATE-PLACEHOLDER-INDEX-TITLE/ => ->(document) { document.title },
+        /TEMPLATE-PLACEHOLDER-INDEX-TITLE/ => ->(document) { document.title }
       }
     end
 
@@ -81,7 +89,7 @@ module Texy
       base_placeholders.each do |regex, document_method|
         placeholder_value = document_method.call(self)
 
-        substitute(file: "#{folder}/#{file}", pattern: regex, replacement: placeholder_value)
+        substitute(file: "#{folder}/#{definition_file}", pattern: regex, replacement: placeholder_value)
       end
 
       say "Base file substitutions complete", :green
@@ -91,7 +99,7 @@ module Texy
       config_placeholders.each do |regex, config_method|
         placeholder_value = config_method.call(configuration)
 
-        substitute(file: "#{folder}/#{file}", pattern: regex, replacement: placeholder_value)
+        substitute(file: "#{folder}/#{definition_file}", pattern: regex, replacement: placeholder_value)
       end
 
       say "Configuration file substitutions complete", :green

data/lib/texy/documents/release_notes.rb

@@ -11,6 +11,11 @@ module Texy
         "git@bitbucket.org:neadwerx/release-notes.git"
       end
 
+      # We don't have definitions extracted for release notes yet
+      def definition_file
+        file
+      end
+
       def type_humanized
         "Release Notes version"
       end

data/lib/texy/documents/statement_of_work.rb

@@ -21,8 +21,8 @@ module Texy
 
       def config_placeholders
         super.merge(
-          /TEMPLATE-PLACEHOLDER-CLIENT-HOURLY-RATE/     => ->(config) { config.client.rate },
-          /TEMPLATE-PLACEHOLDER-CLIENT-RATE-MULTIPLIER/ => ->(config) { config.client.rate_multiplier },
+          /TEMPLATE-PLACEHOLDER-CLIENT-HOURLY-RATE/ => ->(config) { config.client.rate },
+          /TEMPLATE-PLACEHOLDER-CLIENT-RATE-MULTIPLIER/ => ->(config) { config.client.rate_multiplier }
         )
       end
     end

data/lib/texy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Texy
-  VERSION = "0.8.2"
+  VERSION = "0.10.2"
 end

data/texy.gemspec

@@ -5,14 +5,14 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "texy/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "texy"
-  spec.version       = Texy::VERSION
-  spec.authors       = ["Stephen Dolan"]
-  spec.email         = ["stephen@neadwerx.com"]
+  spec.name = "texy"
+  spec.version = Texy::VERSION
+  spec.authors = ["Stephen Dolan"]
+  spec.email = ["stephen@neadwerx.com"]
 
-  spec.summary       = "Command line tool for SoW writing"
-  spec.description   = "Command line tool for SoW writing"
-  spec.homepage      = "https://neadwerx.com"
+  spec.summary = "Command line tool for SoW writing"
+  spec.description = "Command line tool for SoW writing"
+  spec.homepage = "https://neadwerx.com"
 
   raise "RubyGems 2.0 or newer is required to protect against public gem pushes." unless spec.respond_to?(:metadata)
 
@@ -26,17 +26,17 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", "~> 6.0"
   spec.add_dependency "thor", "~> 0.20.3"
   spec.add_dependency "zeitwerk", "~> 2.1"
 
-  spec.add_development_dependency "bundler",  "~> 2.0"
-  spec.add_development_dependency "pry",      "~> 0.12"
-  spec.add_development_dependency "rake",     "~> 10.0"
-  spec.add_development_dependency "rspec",    "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "standard", "~> 0.2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: texy
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.10.2
 platform: ruby
 authors:
 - Stephen Dolan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -133,6 +133,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".tool-versions"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -144,10 +145,9 @@ files:
 - lib/texy.rb
 - lib/texy/configuration.rb
 - lib/texy/configuration/client.rb
-- lib/texy/configuration/nead_werx.rb
+- lib/texy/configuration/company.rb
 - lib/texy/configuration/person.rb
 - lib/texy/document.rb
-- lib/texy/documents/change_order.rb
 - lib/texy/documents/release_notes.rb
 - lib/texy/documents/statement_of_work.rb
 - lib/texy/version.rb
@@ -156,7 +156,7 @@ homepage: https://neadwerx.com
 licenses: []
 metadata:
   homepage_uri: https://neadwerx.com
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,8 +171,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Command line tool for SoW writing
 test_files: []

data/lib/texy/documents/change_order.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Texy
-  module Documents
-    class ChangeOrder < Document
-      def initialize
-        super
-      end
-
-      def self.repository
-        "git@bitbucket.org:neadwerx/leads.git"
-      end
-
-      def type_humanized
-        "Change Order"
-      end
-
-      def type
-        "change_order"
-      end
-
-      def config_placeholders
-        super.merge(
-          /TEMPLATE-PLACEHOLDER-CLIENT-HOURLY-RATE/     => ->(config) { config.client.rate },
-          /TEMPLATE-PLACEHOLDER-CLIENT-RATE-MULTIPLIER/ => ->(config) { config.client.rate_multiplier },
-        )
-      end
-    end
-  end
-end