caracal_the_curve 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1d56aaed7b0a4ebaa54b3e1ec9676a9b1ad7623f3731fcaf39f5b36dbfc9aa8
-  data.tar.gz: aaee3a57ce1de0605812daf5fb1723b591df0ade1258d01e198b6fef14b7faa9
+  metadata.gz: e6da04caa966ebd5e16ea4750f12f96ac92671bc5398040ffac7634c0ace0430
+  data.tar.gz: d22baa3abb96b9a569864e414542d5aacdcff42c42cf71586c95a5c4e855afd0
 SHA512:
-  metadata.gz: a70c88b1cb4b1ced216bbc9d2f6b30557e05a951e9021ec1996c79f8243ea3920b7b1a61cfb391e119748bf4aa3c506606b141814d906f9787d38d854da2b23f
-  data.tar.gz: '01650682a67a3e887eef14c14c7145eebd28afec184aa75214575711a6998d8ca6048bd517ac73100b79ca53d1fd8e12c2633c881cd389b90ec4fa88ad6dc69f'
+  metadata.gz: 700413b3717f24148a68d6d211a817f70dbf1991871942981c8eada98be9a63d629c88c281e8bdb55b328536bccdb1e1bbec23e64057c86648973630aaa9aad9
+  data.tar.gz: 742d487ca24ab7f5aba5a71b844fe9ac42a3a15bde8ba327d6d3b8b7a396dbba5e62036436e71541e1ac13baf5461096164b195b3688b8b685109bbb51d896ea

data/lib/caracal/core/models/field_model.rb

@@ -15,7 +15,7 @@ module Caracal
         #--------------------------------------------------
 
         # constants
-        const_set(:TYPE_MAP, { page: 'PAGE', numpages: 'NUMPAGES', table_of_contents: 'TOC \o "1-1" \h \z \u \t "Heading 5,1"' })
+        const_set(:TYPE_MAP, { page: 'PAGE', numpages: 'NUMPAGES' })
 
         # accessors
         attr_reader :field_dirty

data/lib/caracal/core/models/table_of_contents_model.rb

@@ -0,0 +1,81 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class encapsulates the logic needed to store and manipulate
+      # text data.
+      #
+      class TableOfContentsModel < BaseModel
+
+        #--------------------------------------------------
+        # Configuration
+        #--------------------------------------------------
+
+        # constants
+        const_set(:DEFAULT_OPTS, 'TOC \o "1-1" \h \z \u \t "Heading 5,1"')
+        const_set(:DEFAULT_SIZE, 32)
+        const_set(:DEFAULT_TITLE, 'Table of Contents')
+
+        # accessors
+        attr_reader :toc_opts
+        attr_reader :toc_size
+        attr_reader :toc_title
+
+        #-------------------------------------------------------------
+        # Public Class Methods
+        #-------------------------------------------------------------
+        
+        # initialization
+        def initialize(options={}, &block)
+          @toc_opts  ||= DEFAULT_OPTS
+          @toc_size  ||= DEFAULT_SIZE
+          @toc_title ||= DEFAULT_TITLE
+          super options, &block
+        end
+
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+
+        #=============== GETTERS ==============================
+
+        #========== GETTERS ===============================
+
+        #========== SETTERS ===============================
+
+        # integers
+        [:size].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@toc_#{ m }", value.to_i)
+          end
+        end
+
+        # strings
+        [:title, :opts].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@toc_#{ m }", value.to_s)
+          end
+        end
+
+        #========== VALIDATION ============================
+
+        def valid?
+          a = [:opts, :size, :title]
+          a.map { |m| send("toc_#{ m }") }.compact.size == a.size
+        end
+
+        #--------------------------------------------------
+        # Private Methods
+        #--------------------------------------------------
+        private
+
+        def option_keys
+          [:opts, :size, :title]
+        end
+      end
+    end
+  end
+end

data/lib/caracal/core/table_of_contents.rb

@@ -0,0 +1,34 @@
+require 'caracal/core/models/table_of_contents_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to table of
+    # contents
+    #
+    module TableOfContents
+      def self.included(base)
+        base.class_eval do
+
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+
+          def table_of_contents(*args, &block)
+            options = Caracal::Utilities.extract_options!(args)
+
+            model = Caracal::Core::Models::TableOfContentsModel.new(options, &block)
+            
+            if model.valid?
+              contents << model
+            end
+
+            model
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caracal/document.rb

@@ -22,6 +22,7 @@ require 'caracal/core/relationships'
 require 'caracal/core/rules'
 require 'caracal/core/styles'
 require 'caracal/core/tables'
+require 'caracal/core/table_of_contents'
 require 'caracal/core/text'
 
 require 'caracal/renderers/app_renderer'
@@ -68,6 +69,7 @@ module Caracal
     include Caracal::Core::PageBreaks
     include Caracal::Core::Rules
     include Caracal::Core::Tables
+    include Caracal::Core::TableOfContents
     include Caracal::Core::Text
 
     include Caracal::Core::Footer

data/lib/caracal/renderers/document_renderer.rb

@@ -220,6 +220,59 @@ module Caracal
         end
       end
 
+      def render_tableofcontents(xml, model)
+        xml['w'].sdt do
+          xml['w'].sdtPr do
+            xml['w'].docPartObj do
+              xml['w'].docPartGallery({ 'w:val' => model.toc_title })
+              xml['w'].docPartUnique({ 'w:val' => true })
+            end
+          end
+          xml['w'].sdtContent do
+            xml['w'].p do
+              xml['w'].pPr do
+                xml['w'].pStyle({ 'w:val' => 'ContentsHeading' })
+                xml['w'].rPr do
+                  xml['w'].b
+                  xml['w'].b
+                  xml['w'].bCs
+                  xml['w'].sz({ 'w:val' => model.toc_size })
+                  xml['w'].szCs({ 'w:val' => model.toc_size })
+                end
+              end
+              xml['w'].r do
+                  xml['w'].rPr do
+                  xml['w'].b
+                  xml['w'].bCs
+                  xml['w'].sz({ 'w:val' => model.toc_size })
+                  xml['w'].szCs({ 'w:val' => model.toc_size })
+                end
+                xml['w'].t model.toc_title
+              end
+            end
+            xml['w'].p do
+              xml['w'].r do
+                xml['w'].fldChar({ 'w:fldCharType' => 'begin' })
+              end
+              xml['w'].r do
+                xml['w'].rPr do
+                  render_run_attributes(xml, model, false)
+                end
+                xml['w'].instrText({ 'xml:space' => 'preserve' }) do
+                  xml.text " #{model.toc_opts} "
+                end
+              end
+              xml['w'].r do
+                xml['w'].fldChar({ 'w:fldCharType' => 'separate' })
+              end
+              xml['w'].r do
+                xml['w'].fldChar({ 'w:fldCharType' => 'end' })
+              end
+            end
+          end
+        end
+      end
+
       def render_field(xml, model)
         xml['w'].r do
           xml['w'].fldChar({ 'w:fldCharType' => 'begin' })

data/lib/caracal/version.rb

@@ -1,3 +1,3 @@
 module Caracal
-  VERSION = '1.4.2'
+  VERSION = '1.4.3'
 end

data/spec/lib/caracal/core/models/table_of_contents_model_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Caracal::Core::Models::TableOfContentsModel do
+  subject do
+    described_class.new
+  end
+
+
+  #-------------------------------------------------------------
+  # Configuration
+  #-------------------------------------------------------------
+
+  describe 'configuration tests' do
+
+    # accessors
+    describe 'accessors' do
+      it { expect(subject.toc_opts).to eq 'TOC \o "1-1" \h \z \u \t "Heading 5,1"' }
+      it { expect(subject.toc_size).to eq 32 }
+      it { expect(subject.toc_title).to eq 'Table of Contents' }
+    end
+  end
+
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    #=============== GETTERS ==========================
+
+
+    #=============== SETTERS ==========================
+
+    # integers
+    describe '.size' do
+      before { subject.size(24) }
+
+      it { expect(subject.toc_size).to eq 24 }
+    end
+
+    # strings
+    describe '.opts' do
+      before { subject.opts('TOC \o "1-1"') }
+
+      it { expect(subject.toc_opts).to eq 'TOC \o "1-1"' }
+    end
+    describe '.title' do
+      before { subject.title('Hello World') }
+
+      it { expect(subject.toc_title).to eq 'Hello World' }
+    end
+
+    #=============== VALIDATION ===========================
+
+    describe '.valid?' do
+      describe 'when name provided' do
+        it { expect(subject.valid?).to eq true }
+      end
+      [:opts, :size, :title].each do |prop|
+        describe "when #{ prop } nil" do
+          before do
+            allow(subject).to receive("font_#{ prop }").and_return(nil)
+          end
+        
+          it { expect(subject.valid?).to eq true }
+        end
+      end
+    end
+
+  end
+
+
+  #-------------------------------------------------------------
+  # Private Methods
+  #-------------------------------------------------------------
+
+  describe 'private method tests' do
+
+    # .option_keys
+    describe '.option_keys' do
+      let(:actual)   { subject.send(:option_keys).sort }
+      let(:expected) { [:opts, :size, :title].sort }
+
+      it { expect(actual).to eq expected }
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caracal_the_curve
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - Trade Infomatics
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -163,6 +163,7 @@ files:
 - lib/caracal/core/models/style_model.rb
 - lib/caracal/core/models/table_cell_model.rb
 - lib/caracal/core/models/table_model.rb
+- lib/caracal/core/models/table_of_contents_model.rb
 - lib/caracal/core/models/text_model.rb
 - lib/caracal/core/namespaces.rb
 - lib/caracal/core/page_breaks.rb
@@ -172,6 +173,7 @@ files:
 - lib/caracal/core/relationships.rb
 - lib/caracal/core/rules.rb
 - lib/caracal/core/styles.rb
+- lib/caracal/core/table_of_contents.rb
 - lib/caracal/core/tables.rb
 - lib/caracal/core/text.rb
 - lib/caracal/document.rb
@@ -229,6 +231,7 @@ files:
 - spec/lib/caracal/core/models/style_model_spec.rb
 - spec/lib/caracal/core/models/table_cell_model_spec.rb
 - spec/lib/caracal/core/models/table_model_spec.rb
+- spec/lib/caracal/core/models/table_of_contents_model_spec.rb
 - spec/lib/caracal/core/models/text_model_spec.rb
 - spec/lib/caracal/core/namespaces_spec.rb
 - spec/lib/caracal/core/page_breaks_spec.rb
@@ -303,6 +306,7 @@ test_files:
 - spec/lib/caracal/core/models/style_model_spec.rb
 - spec/lib/caracal/core/models/table_cell_model_spec.rb
 - spec/lib/caracal/core/models/table_model_spec.rb
+- spec/lib/caracal/core/models/table_of_contents_model_spec.rb
 - spec/lib/caracal/core/models/text_model_spec.rb
 - spec/lib/caracal/core/namespaces_spec.rb
 - spec/lib/caracal/core/page_breaks_spec.rb