nanoc-github 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98ed4924d4561de729f3aa70c1c955f5655991dda103c9594987c89127aa8ac8
+  data.tar.gz: 28d63967294e40839d52508ea7c18c902d370c18b4792ea0d57362ea11f3adc7
+SHA512:
+  metadata.gz: eb09ee28dea1f6c8ab415738b544d3008a420283cb0f2396d97233488db54fc7adf39d9bfa0f7ba2097a1f0f754269997da24b4aefa7d32ad909723f3297d916
+  data.tar.gz: c4da759a73c852b0d888959f41ea33a3189c1b8ecd9840eae7f3f249c2f4ea0696b234fd4cc424883b4304f4440872871c698c80c1c23b5c007c87c2685a3d3c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Paweł Pacana
+
+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,36 @@
+# Nanoc::Github
+
+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.
+
+## Usage
+
+Add to `Gemfile` in your nanoc project:
+
+```ruby
+gem "nanoc-github"
+```
+
+Then tell nanoc to load it in `lib/default.rb`:
+
+```ruby
+require "nanoc/github"
+```
+
+At last, enable github data source in `nanoc.yaml`:
+
+```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
+    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)
+```
+
+## 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)

data/lib/nanoc/github.rb

@@ -0,0 +1,72 @@
+require "nanoc"
+require "octokit"
+require "concurrent-ruby"
+
+module Nanoc
+  module Github
+    REGEX = /^(?<metadata>---\s*\n.*?\n?)^(---\s*$\n?)/m
+
+    class Source < Nanoc::DataSource
+      identifier :github
+
+      def items
+        @items ||= begin
+          repository_items.map do |item|
+            identifier     = Nanoc::Identifier.new("/#{item[:name]}")
+            metadata, data = decode(item[:content])
+
+            new_item(data, metadata, identifier, checksum_data: item[:sha])
+          end
+        end
+      end
+
+      private
+
+      def client
+        Octokit::Client.new(access_token: access_token)
+      end
+
+      def decode(content)
+        content   = Base64.decode64(content).force_encoding(encoding)
+        matchdata = content.match(REGEX)
+        metadata  = matchdata ? YAML.safe_load(matchdata[:metadata], permitted_classes: [Time]) : {}
+
+        [metadata, content.gsub(REGEX, '')]
+      end
+
+      def repository_items
+        pool  = Concurrent::FixedThreadPool.new(concurrency)
+        items = Concurrent::Array.new
+          client
+            .contents(repository, path: path)
+            .select { |item| item[:type] == "file" }
+            .each   { |item| pool.post { items << client.contents(repository, path: item[:path]) } }
+        pool.shutdown
+        pool.wait_for_termination
+        items
+      rescue Octokit::NotFound => exc
+        []
+      end
+
+      def encoding
+        @config[:encoding] || "utf-8"
+      end
+      
+      def concurrency
+        @config[:concurrency] || 5
+      end
+
+      def access_token
+        @config[:access_token]
+      end
+
+      def path
+        @config[:path]
+      end
+
+      def repository
+        @config[:repository]
+      end
+    end
+  end
+end

data/lib/nanoc/github/version.rb

@@ -0,0 +1,5 @@
+module Nanoc
+  module Github
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-github
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Paweł Pacana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+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.
+email:
+- pawel.pacana@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.md
+- lib/nanoc/github.rb
+- lib/nanoc/github/version.rb
+homepage: https://github.com/pawelpacana/nanoc-github
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pawelpacana/nanoc-github
+  source_code_uri: https://github.com/pawelpacana/nanoc-github
+  changelog_uri: https://github.com/pawelpacana/nanoc-github/releases
+  bug_tracker_uri: https://github.com/pawelpacana/nanoc-github/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Nanoc content source from git repository
+test_files: []