custom_jekyll 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f87507e433e1d734e249ba8d98608f0103e74f9208715e6fea724151c5b8fac
+  data.tar.gz: 1601f4b7866916c7bc620d934981b5ff7bafa04f6bd404030822befb4c7532c2
+SHA512:
+  metadata.gz: fb4276f1fa7ec5bc77234dfe8fbff40e7f68abd689bf5d8410e12bb04b8c3debc64d87c3bb6710a77a25121f9d1620ab7ee49ba7c295683e4529b8764e9db981
+  data.tar.gz: 34ec283a18660709f904babb09845fdfa92ba34ed8c9b40a18a22c3fd91dbc15c28fcb46287d5db200e5c0fe7d4792cf20ede84965725adb22af2681f5a3d62f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at aurangzaib.danial@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in custom_jekyll.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    custom_jekyll (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  custom_jekyll!
+  pry (~> 0.13.1)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aurangzaib
+
+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,43 @@
+# CustomJekyll
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/custom_jekyll`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'custom_jekyll'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install custom_jekyll
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/custom_jekyll. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CustomJekyll project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/custom_jekyll/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "custom_jekyll"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/custom_jekyll.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "custom_jekyll/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "custom_jekyll"
+  spec.version       = CustomJekyll::VERSION
+  spec.authors       = ["Aurangzaib"]
+  spec.email         = ["aurangzaib.danial@gmail.com"]
+
+  spec.summary       = "Need summary"
+  spec.description   = "Need description"
+  spec.homepage      = "https://github.com/aurangzaib-danial/custom_jekyll"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/aurangzaib-danial/custom_jekyll"
+    spec.metadata["changelog_uri"] = "https://github.com/aurangzaib-danial/custom_jekyll"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.13.1"
+end

data/exe/custom_jekyll

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "custom_jekyll"
+
+site_name = ARGV.first
+
+CustomJekyll::CommandLineController.new.generate(site_name)

data/lib/custom_jekyll.rb

@@ -0,0 +1,11 @@
+require "custom_jekyll/version"
+require 'custom_jekyll/command_line_controller'
+require 'custom_jekyll/generator'
+
+
+module CustomJekyll
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+

data/lib/custom_jekyll/command_line_controller.rb

@@ -0,0 +1,5 @@
+class CustomJekyll::CommandLineController
+  def generate(site_name)
+    CustomJekyll::Generator.new(site_name).generate_site
+  end
+end

data/lib/custom_jekyll/generator.rb

@@ -0,0 +1,60 @@
+class CustomJekyll::Generator
+  attr_reader :site_name
+
+  class << self
+    def path_to_resources
+      $LOAD_PATH.detect do |dir|
+        dir.include?('custom_jekyll') && dir.include?('lib')
+      end
+    end
+
+    def path_to_site_template
+      path_to_resources.dup << '/custom_jekyll/site_template'
+    end
+  end
+  
+  def initialize(site_name)
+   @site_name = site_name 
+   g_site_folder
+  end
+
+  def generate_site
+    copy_templates_to_new_site
+    run_automated_commands
+  end
+
+  def g_site_folder
+    Dir.mkdir(site_name)
+  end
+
+  def copy_templates_to_new_site
+    FileUtils.cp_r(site_template, site_name)
+  end
+
+  def run_automated_commands
+    change_directory_to_site
+    run_bundle_install
+    make_git_repo
+  end
+
+  private
+  
+  def site_template
+    self.class.path_to_site_template << '/.'
+  end
+
+  def change_directory_to_site
+    Dir.chdir(site_name)
+  end
+
+  def run_bundle_install
+    puts "Running bundle install in #{site_name}"
+    ENV["BUNDLE_GEMFILE"] = File.expand_path('Gemfile')
+    system("bundle install")
+  end
+
+  def make_git_repo
+    system("git init")
+  end
+  
+end

data/lib/custom_jekyll/site_template/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.sass-cache
+_site

data/lib/custom_jekyll/site_template/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# gem "rails"
+
+gem "github-pages", "~> 209"

data/lib/custom_jekyll/site_template/README.md

@@ -0,0 +1 @@
+# Add a Fantastic README

data/lib/custom_jekyll/site_template/_config.yml

@@ -0,0 +1,7 @@
+title: 'TODO: Add awesome title'
+defaults:
+  -
+    scope:
+      path: ""
+    values:
+      layout: "default"

data/lib/custom_jekyll/site_template/_includes/footer.html

@@ -0,0 +1,3 @@
+<footer>
+  
+</footer>

data/lib/custom_jekyll/site_template/_includes/head.html

@@ -0,0 +1,5 @@
+<head>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>{{ site.title }}</title>
+  <link rel="stylesheet" type="text/css" href="assets/css/styles.css">
+</head>

data/lib/custom_jekyll/site_template/_includes/header.html

@@ -0,0 +1,3 @@
+<header>
+  
+</header>

data/lib/custom_jekyll/site_template/_layouts/default.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+  
+  {% include head.html %}
+ 
+  <body>
+    
+    {% include header.html %}
+
+    {{ content }}
+
+    {% include footer.html %}
+
+  </body>
+
+</html>

data/lib/custom_jekyll/site_template/_sass/main.scss

@@ -0,0 +1 @@
+// Import all styles here

data/lib/custom_jekyll/site_template/assets/css/styles.scss

@@ -0,0 +1,3 @@
+---
+---
+@import "main";

data/lib/custom_jekyll/site_template/index.html

@@ -0,0 +1,3 @@
+---
+---
+<h1>Hello World!</h1>

data/lib/custom_jekyll/version.rb

@@ -0,0 +1,3 @@
+module CustomJekyll
+  VERSION = "0.1.0"
+end

data/notes.md

@@ -0,0 +1,17 @@
+Custom jekyll -> Ruby command line gem
+
+Problem
+Generating jekyll site with jekyll new, creates a site that is intended for blogging and the minimal flag gives us just bare bones. What I want is a site structure generated that can be used for different static websites and not only jekyll.
+
+Solution
+Custom jekyll is a gem that will generate files that I require to start any kind of static website and not a blog. It is much more better to use jekyll directy if you want to generate a blog.
+
+## Most important features
+1. custom-jekyll new website-name
+2. initialize a git repository inside the folder
+3. generates all the required files
+4. Runs bundle install and also display gem output. 
+
+TODO
+- [x] Set set_template according to your need.
+- [x] Run automated commands like bundle install, initialize git repository

data/site_structure.md

@@ -0,0 +1,21 @@
+## Root
+1. .gitignore
+2. _config.yml
+3. Gemfile
+4. README.md
+5. index.html
+
+## _includes
+1. head
+2. header
+3. footer
+
+## _layouts
+1. default.html
+
+## _sass
+1. main.scss
+
+## assets
+1. css/styles.scss
+2. images

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: custom_jekyll
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aurangzaib
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description: Need description
+email:
+- aurangzaib.danial@gmail.com
+executables:
+- custom_jekyll
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- custom_jekyll.gemspec
+- exe/custom_jekyll
+- lib/custom_jekyll.rb
+- lib/custom_jekyll/command_line_controller.rb
+- lib/custom_jekyll/generator.rb
+- lib/custom_jekyll/site_template/.gitignore
+- lib/custom_jekyll/site_template/Gemfile
+- lib/custom_jekyll/site_template/README.md
+- lib/custom_jekyll/site_template/_config.yml
+- lib/custom_jekyll/site_template/_includes/footer.html
+- lib/custom_jekyll/site_template/_includes/head.html
+- lib/custom_jekyll/site_template/_includes/header.html
+- lib/custom_jekyll/site_template/_layouts/default.html
+- lib/custom_jekyll/site_template/_sass/main.scss
+- lib/custom_jekyll/site_template/assets/css/styles.scss
+- lib/custom_jekyll/site_template/index.html
+- lib/custom_jekyll/version.rb
+- notes.md
+- site_structure.md
+homepage: https://github.com/aurangzaib-danial/custom_jekyll
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/aurangzaib-danial/custom_jekyll
+  source_code_uri: https://github.com/aurangzaib-danial/custom_jekyll
+  changelog_uri: https://github.com/aurangzaib-danial/custom_jekyll
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Need summary
+test_files: []