ledger_sync 1.3.5 → 1.4.0

data/documentation/build.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
+
+cd "$parent_path"
+ruby generate.rb
+cd site
+bundle install
+bundle exec jekyll build -d ../../docs

data/documentation/generate.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Setup
+#
+# gem install bundler
+# Ensure you have http://localhost:5678 (or PORT) as a Redirect URI in QBO.
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'simply_serializable'
+  gem 'ledger_sync', path: '../'
+  gem 'pd_ruby'
+  gem 'colorize'
+  gem 'byebug'
+end
+
+require 'ledger_sync'
+require 'pd_ruby'
+require 'erb'
+require 'fileutils'
+
+require_relative 'helper_methods'
+require_relative 'generators/generator'
+require_relative 'generators/guides/generator'
+require_relative 'generators/reference/generator'
+
+Docs::Guides::Generator.new.generate
+Docs::Reference::Generator.new.generate
+
+green 'All done!'

data/documentation/generators/generator.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative 'template'
+
+module Docs
+  class Generator
+    module Methods
+      def clear_dir(path, except: [])
+        dir_path = docs_path(path)
+        yellow "Clearing: #{dir_path}"
+        Dir.foreach(dir_path) do |f|
+          next if except.include?(f)
+
+          fn = File.join(dir_path, f)
+          next if f == '.'
+          next if f == '..'
+
+          rm(fn)
+        end
+        green "Cleared: #{dir_path}"
+        nl
+      end
+
+      def cp(src, dest, *args)
+        yellow "Copying #{src} to #{dest}"
+        FileUtils.cp_r(src, dest, *args)
+        green "Copied #{src} to #{dest}"
+        nl
+      end
+
+      def destination_path(*args, **keywords)
+        docs_path(*args, **{ format: :md }.merge(keywords))
+      end
+
+      def docs_path(*path, format: nil)
+        path = path.map(&:to_s)
+
+        File.join(
+          docs_root_path,
+          *path[0..-2],
+          [path.last, format].flatten.compact.join('.')
+        )
+      end
+
+      def docs_root_path
+        @docs_root_path ||= ENV.fetch('DOCS_ROOT_PATH', File.join(__dir__, '../site'))
+      end
+
+      def ledgers
+        LedgerSync.ledgers
+                  .to_a
+                  .map(&:last)
+                  .uniq
+                  .to_a
+                  .sort_by(&:root_key)
+      end
+
+      def rm(fn)
+        yellow "Removing: #{fn}"
+        FileUtils.rm_rf(fn, secure: true)
+        green "Removed: #{fn}"
+        nl
+      end
+
+      def template_path(*path, format: :md)
+        path = path.map(&:to_s)
+
+        File.join(
+          docs_root_path,
+          '_templates',
+          *path[0..-2],
+          "#{path.last}.#{format}.erb"
+        )
+      end
+    end
+
+    include Methods
+    extend Methods
+  end
+end

data/documentation/generators/guides/generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Docs
+  module Guides
+    class Generator < Docs::Generator
+      def generate
+        clear_dir(
+          self.class.destination_folder,
+          except: [
+            'index.md'
+          ]
+        )
+
+        ledgers.each_with_index do |ledger, i|
+          Docs::Template.new(
+            data: {
+              ledger: ledger,
+              weight: i + 1
+            },
+            destination_path: destination_path(
+              self.class.destination_folder,
+              ledger.root_key
+            ),
+            template_path: template_path(:guides, :ledger)
+          ).write
+
+          nl
+        end
+      end
+
+      def self.destination_folder
+        'guides/ledgers'
+      end
+    end
+  end
+end

data/documentation/generators/reference/generator.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative 'ledger/generator'
+
+module Docs
+  module Reference
+    class Generator < Docs::Generator
+      def generate
+        ledgers.each do |ledger|
+          Ledger::Generator.new(ledger: ledger).generate
+        end
+
+        generate_indexes
+        generate_layouts
+        update_nav
+      end
+
+      private
+
+      def generate_indexes
+        ledgers.each do |client|
+          Docs::Template.new(
+            data: {
+              client: client.client_class
+            },
+            destination_path: docs_path(:reference, client.root_key, :resources, 'index.md'),
+            template_path: template_path(
+              :reference,
+              :resources,
+              :index
+            )
+          ).write
+        end
+      end
+
+      def generate_layouts
+        ledgers.each do |ledger|
+          Docs::Template.new(
+            data: {
+              client: ledger
+            },
+            destination_path: docs_path(:_layouts, "reference_#{ledger.root_key}.html"),
+            template_path: template_path(
+              :_layouts,
+              :reference_ledger,
+              format: :html
+            )
+          ).write
+        end
+      end
+
+      def update_nav
+        config_path = docs_path('_config.yml')
+        config = YAML.load_file(config_path)
+        nav_links = config['header']['nav_links']
+        nav_links.map do |nav_link|
+          if nav_link['label'] == 'Reference'
+            nav_link['subnav_links'] = ledgers.map do |ledger|
+              {
+                'label' => ledger.name,
+                'url' => "reference/#{ledger.root_key}",
+                'type' => 'link'
+              }
+            end
+          else
+            nav_link
+          end
+        end
+
+        File.open(config_path, 'w') do |h|
+          h.write config.to_yaml
+        end
+      end
+    end
+  end
+end

data/documentation/generators/reference/ledger/generator.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Docs
+  module Reference
+    module Ledger
+      class Generator < Docs::Generator
+        attr_reader :ledger
+
+        def initialize(args = {})
+          @ledger = args.fetch(:ledger)
+        end
+
+        def client_class
+          @client_class ||= ledger.client_class
+        end
+
+        def generate
+          yellow "Generating Reference for #{key}"
+          remove_current_directory
+          copy_template_directory
+          generate_resource_files
+          green "Generated Reference for #{key}"
+        end
+
+        def key
+          @key ||= ledger.root_key
+        end
+
+        def resources
+          @resources ||= client_class.resources.to_a.sort
+        end
+
+        private
+
+        def copy_template_directory
+          cp(docs_path(:_includes, :reference, key), docs_path(:reference))
+        end
+
+        def remove_current_directory
+          rm(docs_path(:reference, key))
+        end
+
+        def generate_resource_files
+          FileUtils.mkdir(docs_path(:reference, key, :resources))
+
+          template_path = Generator.template_path(:reference, :resources, :resource)
+          count = 1
+          resources.each do |resource_key, resource|
+            destination_path = Generator.destination_path(
+              :reference,
+              ledger.root_key,
+              :resources,
+              resource_key
+            )
+
+            Docs::Template.new(
+              data: {
+                resource: resource,
+                client: client_class,
+                weight: count
+              },
+              destination_path: destination_path,
+              template_path: template_path
+            ).write
+
+            count += 1
+          end
+        end
+      end
+    end
+  end
+end

data/documentation/generators/template.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Docs
+  class Template
+    attr_reader :data,
+                :destination_path,
+                :template_path
+
+    def initialize(args = {})
+      @data = args.fetch(:data)
+      @destination_path = args.fetch(:destination_path)
+      @template_path = args.fetch(:template_path)
+    end
+
+    def write
+      template = ERB.new(File.read(template_path), trim_mode: '-')
+      yellow "Generating template: #{template_path}"
+      File.open(destination_path, 'w') { |f| f.write template.result_with_hash(data) }
+      green "Wrote to destination: #{destination_path}"
+    end
+  end
+end

data/documentation/helper_methods.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+def green(str)
+  puts str.colorize(:green)
+end
+
+def yellow(str)
+  puts str.colorize(:yellow)
+end
+
+def red(str)
+  puts str.colorize(:red)
+end
+
+def nl
+  puts "\n"
+end

data/documentation/site/CNAME

@@ -0,0 +1 @@
+www.ledgersync.dev

data/documentation/site/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem "jekyll", "~> 3.8.4"
+
+group :jekyll_plugins do
+    gem "jekyll-menus", "~> 0.6.0"
+    gem "jekyll-paginate-v2", "~> 1.9"
+    gem "jekyll-paginate", "~> 1.1"
+end

data/documentation/site/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.6)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.12.2)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.8.7)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-menus (0.6.1)
+      jekyll (>= 3.6, < 5.0)
+    jekyll-paginate (1.1.0)
+    jekyll-paginate-v2 (1.9.4)
+      jekyll (~> 3.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (1.17.0)
+    liquid (4.0.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.3.6)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (4.0.5)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rouge (3.19.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll (~> 3.8.4)
+  jekyll-menus (~> 0.6.0)
+  jekyll-paginate (~> 1.1)
+  jekyll-paginate-v2 (~> 1.9)
+
+BUNDLED WITH
+   2.1.4

data/documentation/site/LICENSE.md

@@ -0,0 +1,40 @@
+# License Agreement
+##### Version 1.02 (02/14/2019)
+
+This Single Project License Agreement (**“Agreement”**) is between you and Stackbit Inc., a Delaware corporation (“Stackbit”) and governs Your right to use the website project including website theme and other media content (the "Project") obtained from or generated using our services available at www.stackbit.com (the "Services"). By clicking on the “Create Account” button (or any similar button) that is presented to you at the time of sign-up or by using the Site to generate a Project, you indicate that you agree to the terms and conditions of this Agreement. If You are accepting this Agreement on behalf of Your employer or other organization, You are agreeing to these terms for the entity and You represent and warrant that You have authority to bind such entity (party bound to this Agreement is referred to as “You”). 
+
+1. **Definitions**. The capitalized terms shall have the meaning given in the relevant paragraph where such term is defined. In addition, the following terms shall have the meaning set forth below.
+
+   **“Client"** means the person or entity whose website you are designing if you are a web developer, web designer, agency or a marketing agent.
+   
+   **“Theme”** means the website theme made available on the Site and generated using the Services, in HTML/JS/CSS electronic source code format together with any related developer documentation.
+   
+   **“Project”** means any work that includes a Theme or that is derived from or is a ‘derivative work’ of a Theme, as such terms are used under the United States Copyright Act of 1976, as amended.
+
+2.	**License**. Subject to the terms and conditions of this Agreement, Stackbit hereby grants you a perpetual, non-exclusive, non-transferable, non-sublicensable limited license to use, modify, and display the Theme only as incorporated in a single Project as set forth in Section 3 below. All rights not granted herein are expressly reserved by Stackbit.
+
+3.	**Permitted Use**
+
+        You may use the Theme as it is incorporated into a single Project, either your own Project or the Project of your Client, and You may make modifications to the Theme necessary to fit the requirements of the Project provided that the Project and the use of the Project by You or the Client remains subject to this Agreement. You will own the Project you create, but Stackbit retains all right, title and interest in and to the Theme and other media content that are incorporated in your Project. You must retain and include all copyright notices and the terms of this License without modification in the files of the Project. You and Client must use the Project in compliance with all applicable federal, state and local laws, rules and regulations.
+
+4.	**Prohibited Uses**
+
+        You may not, and shall not permit anyone else to, use the Project or do anything with the Project that is not expressly permitted by this Agreement, including, but not limited to, the following strictly prohibited uses:
+
+        1. resell, sublicense or other transfer the Project or the Theme or other components thereof or your rights to use the Theme as set forth herein or otherwise make available or allows a person to access or reproduce the Theme as an electronic file, except in connection with the single Project and subject to Section 3 above;
+    
+        2. Use, reproduce or display the Theme or Project in any manner that competitive with the Services or our business (e.g. inclusion as part of an online website builder service, or distribution outside the Services such as on a Theme/themes marketplace or a "freebies" website);
+    
+        3. Use, reproduce or display of the Theme in a fashion that we consider as, or under applicable law is considered, pornographic, obscene, immoral, infringing, defamatory or libelous; and
+    
+        4. Use or display of the Theme in an electronic format that enables it to be downloaded or distributed in any file sharing arrangement.
+
+5.	**Ownership**. Stackbit shall retain and own all right, title and interest, including but not limited to copyright, patent, trade secret and all other intellectual property rights, in and to the Themes. You shall own all right, title and interest, including but not limited to copyright, patent, trade secret and all other intellectual property rights, in and to the Project, subject to Stackbit’s ownership of the Theme and the terms of this license agreement.
+
+6.	**Term and Termination**.  This Agreement shall commence on the deployment of a Project through Stackbit’s Services to a repository (such as for example to Github) and continue indefinitely until it is terminated in accordance with Section 6. Stackbit may terminate this Agreement if You breach the Agreement and such breach remains uncured for 15 days following Your receipt of written notice from Stackbit. You may terminate this Agreement for convenience and without cause at any time immediately upon written notice to Stackbit. Upon termination of this Agreement for any reason, You and your Client shall a) cease all use of the Theme and the Project b) destroy or delete all copies and archives of the Theme, Projects, and accompanying materials, and c) if requested, confirm to Stackbit in writing that you have complied with these requirements. Any provisions of this Agreement which expressly or by implication are intended to survive its termination will survive and continue to bind the parties.
+
+7.	**Warranty and Disclaimer**. THE SERVICES, SITE, THEME, PROJECT AND ALL CONTENT AVAILABLE THROUGH THE SITE ARE OFFERED “AS IS” AND WITHOUT WARRANTY, AND STACKBIT MAKES NO REPRESENTATION OR WARRANTY OF ANY KIND, WHETHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND SPECIFICALLY DISCLAIMS ALL WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE.
+
+8.	**Limitation of Liability**.  Stackbit’s aggregate liability for all claims, losses, liabilities or damages in connection with this Services, Theme, Project or this Agreement or its subject matter, whether as a result of breach of contract, tort (including negligence) or otherwise, regardless of the theory of liability asserted, is limited to no more than the total amount of fees paid to Stackbit under this Agreement, or $100, whichever is greater.  In addition, Stackbit will not be liable in any event for lost profits, consequential, indirect, punitive, exemplary or special damages.  
+
+9.	**General**. This Agreement shall be governed by the law of the State of California, without reference to conflict of laws principles. The United Nations Convention on contracts for the International Sales of Goods shall not apply. This Agreement, together with the Stackbit Terms of Service at www.stackbit.com/tos/ represents the entire agreement between the parties with regard to the subject matter thereof and supersedes any prior understandings, proposals or agreements concerning the same subject matter. If any provision of this Agreement is found to be unenforceable or invalid, the remainder of such provision shall be enforced to the maximum extent permitted by law. No amendment or modification of this Agreement shall be valid or binding unless in a writing signed by representatives of both parties. You may not assign this Agreement without Stackbit’s prior written consent. Any attempted assignment in violation of this shall be null and void. This Agreement shall be binding upon and inure to the benefit of the parties hereto and their respective permitted successors and assigns. Any notice required or permitted to be given by either party under this Agreement shall be in writing and may be sent via an active Services account dashboard or shall be personally delivered or sent by commercial courier service, or by first class mail (certified or registered if available), or by telecopy confirmed by first class mail (registered or certified if available), to the other party at its address set forth below, or such new address as may from time-to-time be supplied hereunder by the parties hereto.