lb-project 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43956f0e7b1f6e48a65014512abd750ad68c18318bbf3c00aa6d1d49a46a96bc
+  data.tar.gz: 40a8e5823b486781458458dd931f4669ccc722bb48a2503f9c846a700c251c50
+SHA512:
+  metadata.gz: ec0c25e1e978a2c8b261de4ad35febecbb21165032863a597020047b0a15932e79258b83f455671f5c829923b3fafdf0d0345074c316c5b85a6298a17f192e00
+  data.tar.gz: 5bf9094b84a40341f9465fd9a777528c0a1b90f10d5215d532e1b2be2dcfde17cf7e05da585a6d2776579dc2c089497058f7e6ca7d9fb93d365117b2772da575

data/.gitignore

@@ -0,0 +1,41 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.sw[op]
+
+## Rubinius
+*.rbc
+.rbx
+
+## PROJECT::GENERAL
+*.gem
+coverage
+profiling
+turbulence
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.lock
+
+## ctags
+tags
+gems.tags
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1,6 @@
+--color
+--fail-fast
+--format progress
+--profile
+--order random
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1 @@
+./config/rubocop.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+ruby '2.5.0'
+
+gemspec

data/Guardfile

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+guard :bundler do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch(/\A(.+)\.gemspec\z/)
+end
+
+guard :rspec, cmd: 'bundle exec rspec ' +
+                   File.read('.rspec').split.join(' '),
+              failed_mode: :keep do
+  # Run all specs if configuration is modified
+  watch('.rspec')              { 'spec' }
+  watch('Guardfile')           { 'spec' }
+  watch('Gemfile.lock')        { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
+
+  # Run all specs if supporting files files are modified
+  watch(%r{\Aspec/(?:fixtures|lib|support|shared)/.+\.rb\z}) { 'spec' }
+
+  # Run unit specs if associated lib code is modified
+  watch(%r{\Alib/(.+)\.rb\z}) do |m|
+    Dir["spec/unit/#{m[1]}*"]
+  end
+
+  watch(%r{\Alib/(.+)/support/(.+)\.rb\z}) do |m|
+    Dir["spec/unit/#{m[1]}/#{m[2]}*"]
+  end
+
+  watch("lib/#{File.basename(File.expand_path('../', __FILE__))}.rb") do
+    'spec'
+  end
+
+  # Run a spec if it is modified
+  watch(%r{\Aspec/(?:unit|integration|features)/.+_spec\.rb\z})
+end
+
+guard :rubocop, cli: %w[--config config/rubocop.yml] do
+  watch(/.+\.(?:rb|rake|gemspec)\z/)
+  watch(%r{\Aconfig/rubocop\.yml\z})  { |m| File.dirname(m[0]) }
+  watch(%r{(?:.+/)?\.rubocop\.yml\z}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017-2018 Firas Zaidan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+[gem]: https://rubygems.org/gems/lb-project
+[gemnasium]: https://gemnasium.com/lb-rb/lb-project
+[roda]: http://roda.jeremyevans.net/
+[dry-view]: http://dry-rb.org/gems/dry-view/
+
+# lb-project
+
+[![Gem Version](https://badge.fury.io/rb/lb-project.svg)][gem]
+[![Dependency Status](https://gemnasium.com/lb-rb/lb-project.svg)][gemnasium]
+
+This static site builder allows an easy migration to a dynamic site. In many
+projects it is unclear if or when a static site has to be migrated to a dynamic
+one. Maintaining a static site is less work, so we want to keep it static until
+the point is reached, where we have to migrate the project to a full dynamic
+stack.
+
+The target of lb-project is to minimize this migration effort. We use
+[Roda][roda] and [dry-view][dry-view] because this are currently excellent
+solutions that are suited for big projects. This means you can start
+lightweight, without worrying that it becomes to small.
+
+## Credits
+
+ * [Firas Zaidan](https://github.com/zaidan)
+
+## License
+
+See `LICENSE` file.

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'devtools'
+
+Devtools.init_rake_tasks

data/bin/lb-project

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+root = Dir.pwd
+$LOAD_PATH << File.join(root, 'lib')
+
+require 'yaml'
+LB_PROJECT_YML = 'config/lb-project.yml'
+config_file = File.join(root, LB_PROJECT_YML)
+unless File.exist?(config_file)
+  puts "#{LB_PROJECT_YML} not found: '#{config_file}'"
+  exit 1
+end
+config = YAML.load_file(config_file)
+
+begin
+  namespace = config.fetch('namespace')
+  require namespace
+  LB::Project::Render.new.call
+  exit 0
+rescue KeyError
+  puts "'namespace' not set in '#{LB_PROJECT_YML}'!"
+  raise
+rescue LoadError
+  puts "Can not require namespace '#{namespace}'!"
+  puts "Please fix namespace in '#{LB_PROJECT_YML}'."
+  raise
+end
+exit 1

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 0.1

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 4
+total_score: 18

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 8.6

data/config/mutant.yml

@@ -0,0 +1,3 @@
+name: lb-project
+namespace: LB::Project
+ignore_subjects: []

data/config/reek.yml

@@ -0,0 +1,103 @@
+---
+Attribute:
+  enabled: false
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 0
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 2
+  overrides: {}
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 0
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyConstants:
+  enabled: true
+  exclude: []
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 2
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 15
+TooManyStatements:
+  enabled: true
+  exclude: []
+  max_statements: 5
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 0

data/config/rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  DisplayCopNames: true
+  Exclude: []
+Naming/FileName:
+  Exclude:
+    - Rakefile
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100.0

data/lb-project.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require File.expand_path('../lib/lb/project/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'lb-project'
+  gem.version     = LB::Project::VERSION.dup
+  gem.authors     = ['Firas Zaidan']
+  gem.email       = ['firas@zaidan.de']
+  gem.description = 'Static site builder with easy migration to dynamic site'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/lb-rb/lb-project'
+  gem.license     = 'MIT'
+
+  gem.bindir                = 'bin'
+  gem.require_paths         = %w[lib bin]
+  gem.files                 = `git ls-files`
+                              .split($INPUT_RECORD_SEPARATOR)
+  gem.executables           = `git ls-files -- bin/*`
+                              .split("\n").map { |f| File.basename(f) }
+  gem.test_files            = `git ls-files -- spec`
+                              .split($INPUT_RECORD_SEPARATOR)
+  gem.extra_rdoc_files      = %w[README.md]
+  gem.required_ruby_version = '>= 2.5'
+
+  gem.add_dependency 'dry-initializer',  '~> 2.3',  '< 2.4'
+  gem.add_dependency 'dry-struct',       '~> 0.4',  '< 0.5'
+  gem.add_dependency 'dry-types',        '~> 0.12', '< 0.13'
+  gem.add_dependency 'dry-view',         '~> 0.3',  '>= 0.3.0', '< 0.3.1'
+  gem.add_dependency 'r18n-core',        '~> 2.2',  '< 2.3'
+  gem.add_dependency 'roda',             '~> 2.29', '< 2.30'
+  gem.add_dependency 'roda-i18n',        '~> 0.3', '< 0.4'
+
+  gem.add_development_dependency 'devtools',       '~> 0.1.19'
+  gem.add_development_dependency 'guard',          '~> 2.14'
+  gem.add_development_dependency 'guard-bundler',  '~> 2.1'
+  gem.add_development_dependency 'guard-rspec',    '~> 4.7', '>= 4.7.3'
+  gem.add_development_dependency 'guard-rubocop',  '~> 1.3'
+  gem.add_development_dependency 'rubocop',        '~> 0.52'
+  gem.add_development_dependency 'slim',           '~> 3.0'
+end

data/lib/lb/project/app.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module LB
+  module Project
+    # Base class for main routing entry point
+    class App < LB::Project::Route
+    end
+  end
+end

data/lib/lb/project/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module LB
+  module Project
+    # Configuration
+    class Config < Dry::Struct
+      RequiredString = Types::Strict::String.constrained(min_size: 1)
+
+      attribute :base_path, Types::Strict::String
+      attribute :image_base_path, Types::Strict::String
+      attribute :public_path, Types::Strict::String
+      attribute :template_path, Types::Strict::String
+
+      def self.load(root, name, env)
+        path = File.join(File.join(root, 'config'), "#{name}.yml")
+        yaml = File.exist?(path) ? YAML.load_file(path) : {}
+
+        new(config(yaml, env))
+      end
+
+      def self.config(yaml, env)
+        schema.keys.each_with_object({}) do |key, memo|
+          memo[key] = value_for(yaml, env, key)
+        end
+      end
+
+      def self.value_for(yaml, env, key)
+        ENV.fetch(
+          key.to_s.upcase,
+          yaml.fetch(env.to_s, {})[key.to_s]
+        )
+      end
+    end
+  end
+end

data/lib/lb/project/page.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LB
+  module Project
+    # Page view
+    class Page < View
+      extend LB::Project::Registry::Registration[:page]
+
+      def title
+        t = LB::Project.t.page
+        self.class.page_key.split('/').each do |key|
+          t = t.send(key)
+        end
+
+        t.title
+      end
+    end
+  end
+end

data/lib/lb/project/registry/registration.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module LB
+  module Project
+    class Registry
+      # Mixin for registration
+      module Registration
+        def self.[](registry_name, registry = LB::Project::Registry.new)
+          rcmethod = "#{registry_name}_registry_config"
+          setup(registry_name, registry, rcmethod)
+          define_helpers(registry_name, rcmethod) unless respond_to?(rcmethod)
+
+          self
+        end
+
+        def self.define_helpers(registry_name, rcmethod)
+          rmethod = "#{registry_name}_registry"
+
+          define_registry_config(rcmethod)
+          define_registry(rcmethod, rmethod)
+          define_registry_name(registry_name, rcmethod)
+          define_registry_as(registry_name, rmethod)
+          define_key(registry_name)
+        end
+
+        def self.define_registry_config(rcmethod)
+          define_method(rcmethod) do
+            Registration.instance_variable_get("@#{rcmethod}")
+          end
+        end
+
+        def self.define_registry(rcmethod, rmethod)
+          define_method(rmethod) do
+            send(rcmethod).registry
+          end
+        end
+
+        def self.define_registry_name(registry_name, rcmethod)
+          rnmethod = "#{registry_name}_registry_name"
+          define_method(rnmethod) do
+            send(rcmethod).name
+          end
+        end
+
+        def self.define_registry_as(registry_name, rmethod)
+          define_method("register_#{registry_name}_as") do |key|
+            send(rmethod).register(key.to_s, self)
+            instance_variable_set("@#{registry_name}_key", key.to_s)
+          end
+        end
+
+        def self.define_key(registry_name)
+          define_method("#{registry_name}_key") do
+            instance_variable_get("@#{registry_name}_key")
+          end
+        end
+
+        def self.setup(registry_name, registry, rcmethod)
+          config = Config.new(registry_name, registry)
+          Registration.instance_variable_set("@#{rcmethod}", config)
+        end
+
+        # Stores the registration configuration
+        class Config
+          extend Dry::Initializer
+
+          param :name, Dry::Types['coercible.string']
+          param :registry
+        end
+      end
+    end
+  end
+end

data/lib/lb/project/registry.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module LB
+  module Project
+    # Basic key value store
+    class Registry
+      include Dry::Equalizer(:keys)
+      include Enumerable
+
+      attr_reader :keys
+
+      # Error that is raised when key is not found in registry
+      class KeyNotFoundError < KeyError
+        def initialize(key)
+          super("#{key.inspect} doesn't exist in registry")
+        end
+      end
+
+      def initialize(keys = {})
+        @keys = keys
+      end
+
+      def each(&block)
+        return to_enum unless block
+        keys.each_pair { |key, value| yield(key, value) }
+      end
+
+      def key?(key)
+        !key.nil? && keys.key?(key.to_sym)
+      end
+
+      def fetch(key)
+        raise ArgumentError, 'key cannot be nil' if key.nil?
+
+        keys.fetch(key.to_sym) do
+          return yield if block_given?
+
+          raise KeyNotFoundError, key
+        end
+      end
+      alias [] fetch
+
+      def respond_to_missing?(key, include_private = false)
+        keys.key?(key) || super
+      end
+
+      def register(key, value)
+        keys[key] = value
+      end
+
+      private
+
+      def method_missing(key, *)
+        keys.fetch(key) { super }
+      end
+    end
+  end
+end

data/lib/lb/project/render.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LB
+  module Project
+    # Render
+    class Render
+      def call
+        Page.page_registry.each do |name, klass|
+          page = klass.new
+          File.write(file_for(name), page.call(options(page)))
+        end
+      end
+
+      def file_for(name)
+        File.expand_path("#{name}.html", LB::Project.public_path).tap do |file|
+          FileUtils.mkdir_p File.dirname(file)
+        end
+      end
+
+      def options(page, locals = {})
+        {
+          context: ::Struct.new(:site, :page).new(LB::Project::Site.new, page),
+          locals: locals
+        }
+      end
+    end
+  end
+end

data/lib/lb/project/route.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LB
+  module Project
+    # Base route
+    class Route < Roda
+      def self.setup(route)
+        translations = [File.join(LB::Project.root, 'locales')]
+        route.plugin :i18n, translations: translations
+        route.opts[:root] = LB::Project.root
+        route.plugin :public, root: 'docs'
+      end
+    end
+  end
+end

data/lib/lb/project/site.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module LB
+  module Project
+    # Site context for templates
+    class Site
+      include R18n::Helpers
+
+      def initialize(context = {})
+        @context = context
+      end
+
+      def options
+        @options ||= {}
+      end
+
+      def [](*args)
+        options.fetch(*args)
+      end
+
+      def path_for(bundle, type)
+        path = 'webpack-assets.json'
+        file = File.read(path)
+        json = JSON.parse(file)
+        LB::Project.config.base_path + json[bundle][type]
+      end
+
+      def js_for(bundle)
+        path_for(bundle, 'js')
+      end
+
+      def css_for(bundle)
+        path_for(bundle, 'css')
+      end
+
+      def image_path(path)
+        "#{LB::Project.config.image_base_path}/#{path}"
+      end
+    end
+  end
+end

data/lib/lb/project/types.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LB
+  module Project
+    # Custom Types
+    module Types
+      include Dry::Types.module
+    end
+  end
+end