frontman-ssg 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34eef05a89e8a6afd90d01f0e07fe8477e348be90b8de3b603b4b7761d93d73a
-  data.tar.gz: 993051df2124b49cdd7df806c01a7cbe83276f155b08f93d0d4eed00fba342e9
+  metadata.gz: d98534ae36366f01f9b304aa66cf452d69688a68e37f33e53a3b0afab9ce328a
+  data.tar.gz: aa330a04fd43740fff7dfc1ef6d3e46b640a0a428070456933e24141e58d3b86
 SHA512:
-  metadata.gz: 001edb81fb728535077e4dd34dea01ebce3eb184223a6513ce18fcef013c11eaeb601ec5a06503e26b0d0aef2ff24146c2f7bfa59c320f3fc55135dd090f56d4
-  data.tar.gz: 98bac4af65a1747a4b9c34ffd90e991440a94156f5e2d1b33570a3d519d7aaa8e1ea15135cf0a0f7dcce40ed58333abce0e4f6350f918298719b30431ef9131a
+  metadata.gz: 6e23982fea37d56e567c96d9344efb5f98c02fead828861410ead02486fe7d6520eb47d0d509bfd46f57e20e4e0476c1ee69820779074afa51fb1527f985e71e
+  data.tar.gz: b1eab4c96e41d2a38951f8893ef29786b20ed2b31689b6c94bfd22a8263f545f9fdd250d3ce8d097fbd694558744c605e92a1d586485376929d2c295520fe335

data/.rubocop.yml

@@ -4,6 +4,9 @@ AllCops:
     - '**/Rakefile'
     - 'vendor/**/*'
 
+Style/Lambda:
+  Enabled: false
+
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'frontman-ssg.gemspec'
@@ -85,4 +88,4 @@ Metrics/ParameterLists:
 
 Lint/HandleExceptions:
   Exclude:
-    - 'lib/frontman/commands/serve.rb'
+    - 'lib/frontman/commands/serve.rb'

data/CHANGELOG.md

@@ -5,19 +5,30 @@ We document all notable changes to the project in the file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [semantic versioning](http://semver.org/).
 
 # Release Notes
-## [Unreleased](https://github.com/algolia/frontman/compare/0.0.3...master)
+## [Unreleased](https://github.com/algolia/frontman/compare/0.0.4...master)
+
+## [0.0.4](https://github.com/algolia/frontman/tree/0.0.3) - 2020-08-28
+
+### Added
+* Retry strategy to allow for multiple running Frontman processes ([`#24`](https://github.com/algolia/frontman/pull/24)) by [@westonganger](https://github.com/westonganger)
+* Added `--force` flag to the `frontman init` command ([`#29`](https://github.com/algolia/frontman/pull/29)) by [@MikeRogers0](https://github.com/MikeRogers0)
+* Improved data directory registration ([`#30`](https://github.com/algolia/frontman/pull/30)) by [@westonganger](https://github.com/westonganger)
+* `import_config` method to easily load multiple configuration files ([`#34`](https://github.com/algolia/frontman/pull/34)) by [@westonganger](https://github.com/westonganger)
+
+### Fixed
+* Added `https://rubygems.org` as a source for our dependencies ([`#32`](https://github.com/algolia/frontman/pull/32)) by [@MikeRogers0](https://github.com/MikeRogers0)
 
 ## [0.0.3](https://github.com/algolia/frontman/tree/0.0.3) - 2020-08-28
 
-#### Added
+### Added
 * Documentation on the release process.
 * Load possible `.env` files before application bootstrapping.
 * Asset fingerprinting through configuration.
 
-#### Security
+### Security
 * Update dependencies in the Webpack project template.
 
-#### Fixed
+### Fixed
 * Prevent `DataStoreFile` from being converted to `OpenStruct`.
 * Misc. updates to the projects documentation.
 

data/lib/frontman.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'frontman/errors'
 require 'frontman/app'
 require 'frontman/context'
 require 'frontman/config'
 require 'frontman/custom_struct'
 require 'frontman/data_store'
 require 'frontman/data_store_file'
+require 'frontman/errors'
 require 'frontman/sitemap_tree'
 require 'frontman/resource'
 

data/lib/frontman/app.rb

@@ -3,6 +3,7 @@
 
 require 'frontman/sitemap_tree'
 require 'frontman/data_store'
+require 'frontman/errors'
 require 'singleton'
 require 'sorbet-runtime'
 
@@ -94,11 +95,15 @@ module Frontman
       @assets_manifest[key] = '/' + value.sub(%r{^/}, '')
     end
 
-    sig { params(dirs: Array).void }
+    sig { params(dirs: T.any(Array, Hash)).void }
     def register_data_dirs(dirs)
-      dirs.each do |dir|
-        define_singleton_method dir.to_sym do
-          @data_dirs[dir] ||= DataStore.new(File.join(Dir.pwd, dir))
+      if dirs.is_a?(Array)
+        dirs = dirs.map { |dir| [dir.split('/').last, dir] }.to_h
+      end
+
+      dirs.each do |name, dir|
+        define_singleton_method name do
+          @data_dirs[name] ||= DataStore.new(File.join(Dir.pwd, dir))
         end
       end
     end
@@ -127,6 +132,15 @@ module Frontman
       )
     end
 
+    sig { params(file_path: String).void }
+    def import_config(file_path)
+      if !file_path.end_with?('.rb') && !File.exist?(file_path)
+        return import_config("#{file_path}.rb")
+      end
+
+      run File.read(file_path)
+    end
+
     def method_missing(method_id, *_)
       from_view_data = get_from_view_data(method_id)
       return from_view_data unless from_view_data.nil?
@@ -164,12 +178,5 @@ module Frontman
       local_data = @view_data.last[:locals]
       local_data[key] unless local_data.nil?
     end
-
-    class ExistingResourceError < StandardError
-      def self.create(url, resource)
-        new("Unable to redirect for #{url},
-             the resource #{resource.file_path} already exists on this URL")
-      end
-    end
   end
 end

data/lib/frontman/commands/build.rb

@@ -52,7 +52,7 @@ module Frontman
       builder.build_directory = build_directory
       builder.current_build_files = current_build_files
 
-      builder.on('created, updated, deleted, unchanged', lambda { |build_file|
+      builder.on('created, updated, deleted, unchanged', ->(build_file) {
         mapping.add_from_build_file(build_file)
       })
 

data/lib/frontman/commands/init.rb

@@ -6,6 +6,7 @@ require 'thor'
 module Frontman
   class CLI < Thor
     option :template
+    option :force, type: :boolean
     desc 'init', 'Bootstrap a new Frontman project'
     def init(path)
       template = options[:template] || 'default'
@@ -38,6 +39,7 @@ module Frontman
     end
 
     def allowed_to_modify_dir?(dir)
+      return true if options[:force]
       return true if !Dir.exist?(dir) || Dir.empty?(dir)
 
       say 'This folder already contains files. '

data/lib/frontman/commands/serve.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: false
 
+require 'socket'
 require 'thor'
 require 'sinatra/base'
 require 'better_errors'
@@ -8,6 +9,7 @@ require 'frontman/app'
 require 'frontman/bootstrapper'
 require 'frontman/builder/asset_pipeline'
 require 'frontman/config'
+require 'frontman/errors'
 require 'frontman/resource'
 
 module Frontman
@@ -70,11 +72,11 @@ module Frontman
 
       listener.start
 
-      FrontManServer.set :public_folder, Frontman::Config.get(
+      FrontmanServer.set :public_folder, Frontman::Config.get(
         :public_dir, fallback: 'public'
       )
-      FrontManServer.run! do
-        host = "http://localhost:#{FrontManServer.settings.port}"
+      FrontmanServer.run! do
+        host = "http://localhost:#{FrontmanServer.settings.port}"
         print "== View your site at \"#{host}/\"\n"
         processes += assets_pipeline.run_in_background!(:after)
         at_exit { processes.each { |pid| Process.kill(0, pid) } }
@@ -83,8 +85,34 @@ module Frontman
   end
 end
 
-class FrontManServer < Sinatra::Base
-  set :port, 4568
+class FrontmanServer < Sinatra::Base
+  port = Frontman::Config.get(:port, fallback: 4568)
+  num_retries = Frontman::Config.get(:port_retries, fallback: 3)
+
+  retry_strategy = Frontman::Config.get(:port_retry_strategy, fallback: ->(p) {
+    port_in_use = false
+
+    (1 + num_retries).times do
+      begin
+        port_in_use = Socket.tcp('localhost', p, connect_timeout: 3) { true }
+      rescue StandardError
+        port_in_use = false
+      end
+
+      break unless port_in_use
+
+      p += 1
+    end
+
+    raise Frontman::ServerPortError if port_in_use
+
+    p
+  })
+
+  port = retry_strategy.call(port)
+
+  set :port, port
+
   set :server_settings,
       # Avoid having webrick displaying logs for every requests to the serve
       AccessLog: [],

data/lib/frontman/errors.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Frontman
+  class Error < StandardError; end
+
+  class DuplicateResourceError < StandardError
+    def self.create(resource, url, existing_resource)
+      new("Unable to add #{resource.file_path} as #{url}.
+           Resource #{existing_resource.file_path} already exists on this URL.")
+    end
+  end
+
+  class ExistingRedirectError < StandardError
+    def self.create(resource, url)
+      new("Unable to add #{resource.file_path} as #{url}.
+           A redirect already exists for this URL.")
+    end
+  end
+
+  class ExistingResourceError < StandardError
+    def self.create(url, resource)
+      new("Unable to redirect for #{url},
+           the resource #{resource.file_path} already exists on this URL")
+    end
+  end
+
+  class ServerPortError < StandardError
+    def initialize
+      super('Server failed to attach to port. Please shutdown some processes
+             or increase the :port_retries configuration variable.')
+    end
+  end
+end

data/lib/frontman/sitemap_tree.rb

@@ -1,6 +1,8 @@
 # typed: false
 # frozen_string_literal: true
 
+require 'frontman/errors'
+
 module Frontman
   class SitemapTree
     attr_reader :path, :children, :url_part
@@ -194,18 +196,4 @@ module Frontman
       "SitemapTree: #{@resource ? @resource.destination_path : @url_part}"
     end
   end
-
-  class DuplicateResourceError < StandardError
-    def self.create(resource, url, existing_resource)
-      new("Unable to add #{resource.file_path} as #{url}.
-           Resource #{existing_resource.file_path} already exists on this URL.")
-    end
-  end
-
-  class ExistingRedirectError < StandardError
-    def self.create(resource, url)
-      new("Unable to add #{resource.file_path} as #{url}.
-           A redirect already exists for this URL.")
-    end
-  end
 end

data/lib/frontman/version.rb

@@ -2,5 +2,5 @@
 
 module Frontman
   # Current Version
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/project-templates/default/Gemfile

@@ -1,3 +1,5 @@
 # frozen_string_literal: true
 
+source 'https://rubygems.org'
+
 gem 'frontman-ssg'

data/project-templates/webpack/Gemfile

@@ -1,3 +1,5 @@
 # frozen_string_literal: true
 
+source 'https://rubygems.org'
+
 gem 'frontman-ssg'

data/spec/frontman/app_spec.rb

@@ -45,4 +45,26 @@ describe Frontman::App do
   it 'should return itself when calling app' do
     expect(subject.app).to eq subject
   end
+
+  it 'should register variables named after keys if hash passed' do
+    subject.register_data_dirs(my_data: 'spec/frontman/mocks')
+    subject.my_data
+    subject.my_data.info
+    subject.my_data.nested.data
+    subject.my_data.nested.more_data
+    expect { subject.mocks }.to raise_error NoMethodError
+  end
+
+  it 'should register variables named after data directory names if array passed' do
+    subject.register_data_dirs(['spec/frontman/mocks'])
+    subject.mocks
+    subject.mocks.info
+    subject.mocks.nested.data
+    subject.mocks.nested.more_data
+    expect { subject.data }.to raise_error NoMethodError
+  end
+
+  it 'should work with import_config' do
+    expect(subject.import_config('spec/frontman/mocks/import_config'))
+  end
 end

data/spec/frontman/bootstrapper_spec.rb

@@ -20,7 +20,7 @@ describe Frontman::Bootstrapper do
     it 'should find all resources in a given folder' do
       resources = Frontman::Bootstrapper.resources_from_dir('spec/frontman/mocks')
 
-      expect(resources.size).to eq 14 # Number of non-YAML files in this folder
+      expect(resources.size).to eq 15 # Number of non-YAML files in this folder
     end
   end
 end

data/spec/frontman/mocks/import_config.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+import_config 'spec/frontman/mocks/config'
+import_config 'spec/frontman/mocks/config.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frontman-ssg
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Devin Beeuwkes
@@ -376,6 +376,7 @@ files:
 - lib/frontman/custom_struct.rb
 - lib/frontman/data_store.rb
 - lib/frontman/data_store_file.rb
+- lib/frontman/errors.rb
 - lib/frontman/helpers/app_helper.rb
 - lib/frontman/helpers/link_helper.rb
 - lib/frontman/helpers/render_helper.rb
@@ -462,6 +463,7 @@ files:
 - spec/frontman/mocks/html_file.html
 - spec/frontman/mocks/html_file.html.md.erb
 - spec/frontman/mocks/html_file.md.html
+- spec/frontman/mocks/import_config.rb
 - spec/frontman/mocks/info.yml
 - spec/frontman/mocks/layouts/raw_without_body.haml
 - spec/frontman/mocks/nested/data.yml