nanoc-github 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df7617ea3b0051571d87c07cc323c6df1164b19b525d94bbd84ccef3456888b8
-  data.tar.gz: 2579afafcde3ead1a537a41de736c10152e59e97d78811baa58e6947bbbf4f1d
+  metadata.gz: fd984944196f6054b8fd003d57caa00c57651f843112c2f16305be56e1ec8e4d
+  data.tar.gz: 50435138314259aa25e3649663b695b5e0f52e3f12a7a278b70d3c513e8ea6bb
 SHA512:
-  metadata.gz: f7d327a0a0e097ab9db731ff7941b76e74fbe1556ee28d9cb68929d4e86b873783e85643391ced643327f8a0420cde465953b031f26d16360ce5e5cfc2385f16
-  data.tar.gz: 2c3b89f16b0a5ca4d7092a76290d412abbe7c39f172646bebb5800261befa04932345aa683c3f07ea6e169966c6bc7c4ab0b5ed1bf3e768d4d1db881637ea854
+  metadata.gz: 9dcbbff78cc680d767f444202bb501861372afd2bf1ba704ebc8ebcc8f3d2aa705d528ad09e8e204212921a771d0963288ff01ba33e6099b66599d3ad15653e0
+  data.tar.gz: c4f2ba46b7c121bbe37fb04cb456e619d2dde881c68496a7d679a3471186635278f053983d1de56566aec67735c88a3dc0dd364c50e01d3463d2e53b3caaabf3

data/README.md

@@ -1,6 +1,6 @@
 # Nanoc::Github
 
-Content source from git repository. A way to have your writing in public and open for edition while not being distracted 
+Content source from git repository. A way to have your writing in public and open for editing while not being distracted
 by static site generator trivia this content is usually mixed with.
 
 ## Usage
@@ -23,14 +23,16 @@ At last, enable github data source in `nanoc.yaml`:
 data_sources:
   - type: github
     items_root: /posts                             # the root where items should be mounted
-    repository: arkency/posts-from-arkency-blog    # organization/repository on github to use as a source of content
+    repository: arkency/posts                      # organization/repository on github to use as a source of content
     encoding: utf-8                                # how to decode content                                            (default: utf-8)
     access_token: secret123                        # github access token, not required for public repositories        (default: nil)
     path: posts/                                   # subdirectory of the content in given repository                  (default: nil)
     concurrency: 10                                # how many threads to spawn to fetch data                          (default: 5)
+    verbose: true                                  # show HTTP cache hit/miss on STDOUT                               (default: false)
+    max_age: 600                                   # override time in which cached content is considered to be fresh  (default: 60)
 ```
 
 ## Status
 
 [![build status](https://github.com/pawelpacana/nanoc-github/workflows/test/badge.svg)](https://github.com/pawelpacana/nanoc-github/actions)
-[![gem version](https://badge.fury.io/rb/nanoc-github.svg)](https://badge.fury.io/rb/nanoc-github)
+[![gem version](https://badge.fury.io/rb/nanoc-github.svg)](https://badge.fury.io/rb/nanoc-github)

data/lib/nanoc/github.rb

@@ -1,14 +1,68 @@
 require "nanoc"
 require "octokit"
 require "concurrent-ruby"
+require "faraday/http_cache"
+require "pstore"
 
 module Nanoc
   module Github
     REGEX = /^(?<metadata>---\s*\n.*?\n?)^(---\s*$\n?)/m
 
+    class Cache
+      def initialize(cache_dir)
+        @store = PStore.new(File.join(cache_dir, "nanoc-github.store"), true)
+      end
+
+      def write(name, value, options = nil)
+        store.transaction { store[name] = value }
+      end
+
+      def read(name, options = nil)
+        store.transaction(true) { store[name] }
+      end
+
+      def delete(name, options = nil)
+        store.transaction { store.delete(name) }
+      end
+
+      private
+      attr_reader :store
+    end
+
+    class ModifyMaxAge < Faraday::Middleware
+      def initialize(app, time:)
+        @app  = app
+        @time = Integer(time)
+      end
+
+      def call(request_env)
+        @app.call(request_env).on_complete do |response_env|
+          response_env[:response_headers][:cache_control] = "public, max-age=#{@time}, s-maxage=#{@time}"
+        end
+      end
+    end
+
     class Source < Nanoc::DataSource
       identifier :github
 
+      def up
+        stack = Faraday::RackBuilder.new do |builder|
+          builder.use Faraday::HttpCache,
+            serializer: Marshal,
+            shared_cache: false,
+            store: Cache.new(tmp_dir),
+            logger: verbose ? logger : nil
+          builder.use ModifyMaxAge, time: max_age
+          builder.use Faraday::Request::Retry,
+            exceptions: [Octokit::ServerError]
+          builder.use Octokit::Middleware::FollowRedirects
+          builder.use Octokit::Response::RaiseError
+          builder.use Octokit::Response::FeedParser
+          builder.adapter Faraday.default_adapter
+        end
+        Octokit.middleware = stack
+      end
+
       def items
         @items ||= begin
           repository_items.map do |item|
@@ -51,7 +105,7 @@ module Nanoc
       def encoding
         @config[:encoding] || "utf-8"
       end
-      
+
       def concurrency
         @config[:concurrency] || 5
       end
@@ -67,6 +121,22 @@ module Nanoc
       def repository
         @config[:repository]
       end
+
+      def verbose
+        @config[:verbose]
+      end
+
+      def max_age
+        @config[:max_age] || 60
+      end
+
+      def logger
+        Logger.new(STDOUT)
+      end
+
+      def tmp_dir
+        File.join(@site_config.dir, "tmp")
+      end
     end
   end
 end

data/lib/nanoc/github/version.rb

@@ -1,5 +1,5 @@
 module Nanoc
   module Github
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-github
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Paweł Pacana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoc
@@ -58,6 +58,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Nanoc content source from git repository. A way to have your writing in public and open for edition while not being
   distracted by static site generator trivia this content is usually mixed with.
@@ -96,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Nanoc content source from git repository