jekyll-extract 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62fd817b191162e43f68e6c932a74b54e95a4956
+  data.tar.gz: 94029b5b0a3729c969ee1cb5d6a403ae97f05803
+SHA512:
+  metadata.gz: 81a9156f826262e48e925d29b63e606cea490dba6b654b688d318cd084eef106d657472341a2a17fa219942f1a02b454974b6d4eec3d3a6ed3f9d3dc12c7a697
+  data.tar.gz: edb7166db5db49c3a4fa37fbb6bbf5970bd60cd7c8d86eae61447232c3599bc941546cc7aea1b519f39cc5ceb7142d5d81deb8c4232d6aeaaee659170522636b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ashwin Maroli
+
+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,97 @@
+# Jekyll Extract
+
+A plugin that adds a new Jekyll command to easily copy files and directories from a theme-gem to your site's source directory.
+
+
+## Installation
+
+Add this plugin to your site's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-extract"
+end
+```
+...and run:
+
+    $ bundle
+
+
+## Usage
+
+`jekyll extract` command is meant to simplify accessing a Jekyll theme-gem and copying the files you wish to customize, to your site's configured source directory.
+
+Run `jekyll extract` with a `--list-all` switch to get an idea about all files bundled in the current theme:
+
+```sh
+# demo using Minima v2.1.1
+
+$ bundle exec jekyll extract --list-all
+[...]
+         Listing: All files in current theme
+                   * assets/main.scss
+                   * LICENSE.txt
+                   * README.md
+                   * _includes/disqus_comments.html
+                   * _includes/footer.html
+                   * _includes/google-analytics.html
+                   * _includes/head.html
+                   * _includes/header.html
+                   * _includes/icon-github.html
+                   * _includes/icon-github.svg
+                   * _includes/icon-twitter.html
+                   * _includes/icon-twitter.svg
+                   * _layouts/default.html
+                   * _layouts/home.html
+                   * _layouts/page.html
+                   * _layouts/post.html
+                   * _sass/minima/_base.scss
+                   * _sass/minima/_layout.scss
+                   * _sass/minima/_syntax-highlighting.scss
+                   * _sass/minima.scss
+```
+
+To copy an entire directory over to the source directory (henceforth referenced by the phrase *"extract to source"*), pass the directory-path, relative to the gem, as the argument:
+
+```sh
+$ bundle exec jekyll extract _layouts
+```
+
+To extract multiple directories simultaneously, pass each directory path as arguments:
+
+```sh
+$ bundle exec jekyll extract _layouts _sass/minima
+```
+will extract contents of both `_layouts` and `_sass/minima` to source, creating the directories as required.
+
+Similarly extract certain files like below:
+
+To check what files are bundled in a particular directory, run the command with a `--show` switch:
+
+```sh
+$ bundle exec jekyll extract _layouts --show
+[...]
+           Listing: Contents of '_layouts' in theme gem...
+                     * _layouts/default.html
+                     * _layouts/home.html
+                     * _layouts/page.html
+                     * _layouts/post.html
+
+```
+Now, to extract just a couple of layouts from the list, run:
+
+```sh
+$ bundle exec jekyll extract _layouts/default.html _layouts/page.html
+```
+The above command will extract these two files to your site's source directory.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ashmaroli/jekyll-extract. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/jekyll-extract.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Jekyll
+  autoload :ThemeGemExtractor, "theme_gem_extractor"
+
+  module Commands
+    class Extract < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:extract) do |c|
+            c.syntax "extract [DIR (or) FILE-PATH] [options]"
+            c.description "Extract theme-gem contents to source directory"
+
+            c.option "show", "--show", "List the contents of the specified [DIR]"
+            c.option "force", "--force", "Force extraction even if file already exists"
+            c.option "list-all", "--list-all", "List all files in the theme-gem"
+
+            c.action do |args, options|
+              process(args, options)
+            end
+          end
+        end
+
+        def process(args, options = {})
+          unless options["list-all"]
+            raise ArgumentError, "You must specify a path." if args.empty?
+          end
+
+          config = Jekyll.configuration(options)
+          @site ||= Site.new(config)
+
+          Jekyll.logger.info "Source Directory:", config["source"]
+          Jekyll.logger.info "Theme Directory:", @site.theme.root
+          puts ""
+
+          return list_all_files if options["list-all"]
+
+          # Substitute leading special-characters in an argument with an
+          # 'underscore' to disable extraction of files outside the theme-gem
+          # but allow extraction of theme directories with a leading underscore.
+          #
+          # Process each valid argument individually to enable extraction of
+          # multiple files or directories.
+          args.map { |i| i.sub(%r!\A\W!, "_") }.each do |arg|
+            ThemeGemExtractor.new(@site, options).extract arg
+          end
+        end
+
+        private
+
+        def list_all_files
+          Jekyll.logger.info "Listing:", "All files in current theme"
+          Dir["#{@site.theme.root}/**/*"].each do |file|
+            next if File.directory?(file)
+            Jekyll.logger.info "",
+              "  * #{file.sub(@site.in_theme_dir("/"), "")}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/theme_gem_extractor.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class ThemeGemExtractor
+    attr_reader :site, :options, :theme_root
+
+    def initialize(site, options)
+      @site = site
+      @options = options
+      @theme_root = site.in_theme_dir("/")
+    end
+
+    def extract(path)
+      file_path = site.in_theme_dir path
+      unless File.exist?(file_path)
+        puts ""
+        raise ArgumentError,
+          "Specified path #{path.yellow} doesn't exist in the theme-gem."
+      end
+      extract_to_source file_path
+    end
+
+    def extract_to_source(path)
+      return list_contents(path) if options["show"]
+
+      if File.directory? path
+        extract_directory_contents path
+      else
+        extract_file_with_directory path
+      end
+    end
+
+    def extract_directory_contents(path)
+      destination = site.in_source_dir relative_path(path)
+      if File.exist?(destination) && !options["force"]
+        already_exists_msg path
+      else
+        extract_contents path, destination
+      end
+    end
+
+    def extract_contents(source, destination)
+      FileUtils.cp_r "#{source}/.", destination
+      files_in(source).each do |file|
+        extraction_msg file
+      end
+    rescue Errno::ENOENT
+      FileUtils.mkdir_p destination
+      retry
+    end
+
+    def extract_file_with_directory(file_path)
+      file = file_path.split("/").last
+      dir_path = File.dirname(
+        site.in_source_dir(relative_path(file_path))
+      )
+      FileUtils.mkdir_p dir_path
+
+      if File.exist?(File.join(dir_path, file)) && !options["force"]
+        already_exists_msg file_path
+      else
+        FileUtils.cp_r file_path, dir_path
+        extraction_msg file_path
+      end
+    end
+
+    def list_contents(path)
+      if File.directory? path
+        directory_listing path
+      else
+        Jekyll.logger.warn "", "The --show switch only works for directories"
+      end
+    end
+
+    def directory_listing(path)
+      Jekyll.logger.info "Listing:",
+        "Contents of '#{relative_path(path)}' in theme gem..."
+
+      files_in(path).each do |file|
+        Jekyll.logger.info "", "  * #{relative_path(file)}"
+      end
+    end
+
+    def files_in(dir_path)
+      Dir["#{dir_path}/**/*"].reject { |d| File.directory? d }
+    end
+
+    def relative_path(path)
+      path.sub theme_root, ""
+    end
+
+    def extraction_msg(file)
+      Jekyll.logger.info "Extract:", relative_path(file)
+    end
+
+    def already_exists_msg(file)
+      Jekyll.logger.warn "Error:", "'#{relative_path(file)}' already " \
+        "exists at destination. Use --force to overwrite."
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-extract
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashwin Maroli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+description: 
+email:
+- ashmaroli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-extract.rb
+- lib/theme_gem_extractor.rb
+homepage: https://github.com/ashmaroli/jekyll-extract
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: A Jekyll command to easily copy theme-gem contents to source directory.
+test_files: []