custom_jekyll 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f87507e433e1d734e249ba8d98608f0103e74f9208715e6fea724151c5b8fac
-  data.tar.gz: 1601f4b7866916c7bc620d934981b5ff7bafa04f6bd404030822befb4c7532c2
+  metadata.gz: 7111645d46352fb62b80654cb064077e0f8f6de78a4acf8e3316c09ed52a6058
+  data.tar.gz: c59579f3cf37248af6b58b2e58a9234f9782cb885a0198f45876594ffa07ff46
 SHA512:
-  metadata.gz: fb4276f1fa7ec5bc77234dfe8fbff40e7f68abd689bf5d8410e12bb04b8c3debc64d87c3bb6710a77a25121f9d1620ab7ee49ba7c295683e4529b8764e9db981
-  data.tar.gz: 34ec283a18660709f904babb09845fdfa92ba34ed8c9b40a18a22c3fd91dbc15c28fcb46287d5db200e5c0fe7d4792cf20ede84965725adb22af2681f5a3d62f
+  metadata.gz: 83e273d061461173ed0deeedc934afb97496d9dc119e0b3cefdad2f3d16fc6eb04c5aa96eed230eaf94cc390de5caa106d764a0f315088b1a30294c478ae4c46
+  data.tar.gz: cdd2b301282cdf9383a4fcf2f07fe16de53a4a4842cc57b883307aaee062e1786b1a24d0be74c9135c6a07957ed3dbc9eafbc5d757487fab84766694d350e3b4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    custom_jekyll (0.1.0)
+    custom_jekyll (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,29 +1,29 @@
 # CustomJekyll
+The purpose of this gem is to make one's life easy while making any kind of site with jekyll. This gem is a mere generator that will generate all the files required for you to start any kind of static website using jekyll. Jekyll default generator is focused for blogs. I love to make different static websites and hosting them using github pages. 
 
-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
+Generate using CustomJekyll and have the basic structure for creating any kind of static website and then hosting it on GithubPages.
+    
 
 ## Usage
+### Install
+```shell
+$ gem install custom_jekyll
+```
+### Generate a site
+```shell
+$ custom_jekyll static-is-fun-with-jekyll
+```
+### if you do not like the name custom_jekyll (I totally understand :P)
+Add the following in your shell's profile
 
-TODO: Write usage instructions here
+```shell
+alias cj="custom_jekyll"
+```
+then
 
+```shell
+$ cj learning-flexbox
+```
 ## 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.
@@ -40,4 +40,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/aurangzaib-danial/custom_jekyll/blob/master/CODE_OF_CONDUCT.md).

data/custom_jekyll.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Aurangzaib"]
   spec.email         = ["aurangzaib.danial@gmail.com"]
 
-  spec.summary       = "Need summary"
-  spec.description   = "Need description"
+  spec.summary       = "Generate using CustomJekyll and have the basic structure for creating any kind of static website and then hosting it on GithubPages."
+  spec.description   = "The purpose of this gem is to make one's life easy while making any kind of site with jekyll. This gem is a mere generator that will generate all the files required for you to start any kind of static website using jekyll. Jekyll default generator is focused for blogs. I love to make different static websites and hosting them using github pages. "
   spec.homepage      = "https://github.com/aurangzaib-danial/custom_jekyll"
   spec.license       = "MIT"
 

data/lib/custom_jekyll/generator.rb

@@ -20,7 +20,9 @@ class CustomJekyll::Generator
 
   def generate_site
     copy_templates_to_new_site
+    change_directory_to_site
     run_automated_commands
+    add_site_name_to_site_config
   end
 
   def g_site_folder
@@ -32,21 +34,26 @@ class CustomJekyll::Generator
   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 << '/.'
+  def add_site_name_to_site_config
+    config = File.read('_config.yml')
+    config.gsub!('%site_title%', humanize_site_name)
+    overwrite_config(config)
   end
 
   def change_directory_to_site
     Dir.chdir(site_name)
   end
 
+  private
+  
+  def site_template
+    self.class.path_to_site_template << '/.'
+  end
+
   def run_bundle_install
     puts "Running bundle install in #{site_name}"
     ENV["BUNDLE_GEMFILE"] = File.expand_path('Gemfile')
@@ -56,5 +63,15 @@ class CustomJekyll::Generator
   def make_git_repo
     system("git init")
   end
+
+  def humanize_site_name
+    site_name.split(/-|\s/).map {|w| w.capitalize}.join("\s")
+  end
+
+  def overwrite_config(content)
+    File.open '_config.yml', 'w' do |f|
+      f.write content
+    end
+  end
   
 end

data/lib/custom_jekyll/site_template/_config.yml

@@ -1,4 +1,4 @@
-title: 'TODO: Add awesome title'
+title: %site_title%
 defaults:
   -
     scope:

data/lib/custom_jekyll/version.rb

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

data/notes.md

@@ -15,3 +15,5 @@ Custom jekyll is a gem that will generate files that I require to start any kind
 TODO
 - [x] Set set_template according to your need.
 - [x] Run automated commands like bundle install, initialize git repository
+- [x] edit config to include site_name
+- [ ] fix readme and gem description

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: custom_jekyll
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aurangzaib
@@ -66,7 +66,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.1
-description: Need description
+description: 'The purpose of this gem is to make one''s life easy while making any
+  kind of site with jekyll. This gem is a mere generator that will generate all the
+  files required for you to start any kind of static website using jekyll. Jekyll
+  default generator is focused for blogs. I love to make different static websites
+  and hosting them using github pages. '
 email:
 - aurangzaib.danial@gmail.com
 executables:
@@ -130,5 +134,6 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Need summary
+summary: Generate using CustomJekyll and have the basic structure for creating any
+  kind of static website and then hosting it on GithubPages.
 test_files: []