Merge pull request sujaykundu777#153 from sujaykundu777/patch/june-2022

updated gems and ruby guides

.github/workflows/codeql-analysis.yml

@@ -28,7 +28,7 @@ jobs:
     # Check that the Jekyll can actually build
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Build the site in the jekyll/builder container
         run: |
           docker run \
@@ -43,7 +43,7 @@ jobs:
     # Check markdown files are markdown-lint compliant
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Lint markdown files with markdown-lint
         uses: articulate/[email protected]
         with:

.ruby-version

@@ -1 +1 @@
-3.0.2
+ruby-3.1.2

Gemfile

@@ -1,7 +1,9 @@
 source "https://rubygems.org"
 
-gem 'jekyll', '~> 4.2', '>= 4.1.1'
-gem 'bundler', '~> 2.3.8'
+gem 'jekyll', '~> 4.2.2', '>= 4.1.1'
+gem 'bundler', '~> 2.3.15'
+gem 'faraday-retry'
+gem 'backports', '~> 3.23'
 gem 'kramdown'
 gem 'rack-jekyll'
 gem 'rack'
@@ -16,10 +18,10 @@ gem 'puma'
 group :jekyll_plugins do
     # gem 'devlopr', '~> 0.4.5'
     gem 'jgd', '~> 1.12'
-    gem 'jekyll-feed', '~> 0.13.0'
+    gem 'jekyll-feed', '~> 0.16.0'
     gem 'jekyll-paginate', '~> 1.1.0'
     gem 'jekyll-gist', '~> 1.5.0'
-    gem 'jekyll-seo-tag', '~> 2.6.1'
+    gem 'jekyll-seo-tag', '~> 2.8.0'
     gem 'jekyll-sitemap', '~> 1.4.0'
     gem 'jekyll-admin', '~> 0.11.0'
 end
@@ -28,10 +30,10 @@ end
 # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
 # and associated library.
 install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
-  gem "tzinfo", "~> 1.2"
+  gem "tzinfo", "~> 2.0"
   gem "tzinfo-data"
 end
 
 # Performance-booster for watching directories on Windows
 gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform?
-gem "webrick", "~> 1.7"
+gem "webrick", "~> 1.7"

Gemfile.lock

@@ -5,33 +5,15 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     backports (3.23.0)
     colorator (1.1.0)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    faraday (1.10.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
+    faraday-net_http (2.0.3)
     faraday-retry (1.0.3)
     ffi (1.15.5)
     forwardable-extended (2.6.0)
@@ -57,23 +39,23 @@ GEM
       jekyll (>= 3.7, < 5.0)
       sinatra (~> 1.4)
       sinatra-contrib (~> 1.4)
-    jekyll-feed (0.13.0)
+    jekyll-feed (0.16.0)
       jekyll (>= 3.7, < 5.0)
     jekyll-gist (1.5.0)
       octokit (~> 4.2)
     jekyll-paginate (1.1.0)
     jekyll-sass-converter (2.2.0)
       sassc (> 2.0.1, < 3.0)
-    jekyll-seo-tag (2.6.1)
-      jekyll (>= 3.3, < 5.0)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
     jekyll-sitemap (1.4.0)
       jekyll (>= 3.7, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     jgd (1.12)
       jekyll (>= 1.5.1)
       trollop (= 2.9.9)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
@@ -83,15 +65,14 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
     multi_json (1.15.0)
-    multipart-post (2.1.1)
     nio4r (2.5.8)
-    octokit (4.22.0)
-      faraday (>= 0.9)
-      sawyer (~> 0.8.0, >= 0.5.3)
+    octokit (4.24.0)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (4.0.6)
-    puma (5.6.2)
+    public_suffix (4.0.7)
+    puma (5.6.4)
       nio4r (~> 2.0)
     rack (1.6.13)
     rack-jekyll (0.5.0)
@@ -106,14 +87,14 @@ GEM
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rexml (3.2.5)
-    rouge (3.28.0)
+    rouge (3.29.0)
     ruby2_keywords (0.0.5)
     safe_yaml (1.0.5)
     sassc (2.4.0)
       ffi (~> 1.9)
-    sawyer (0.8.2)
+    sawyer (0.9.2)
       addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
+      faraday (>= 0.17.3, < 3)
     sinatra (1.4.8)
       rack (~> 1.5)
       rack-protection (~> 1.4)
@@ -127,12 +108,11 @@ GEM
       tilt (>= 1.3, < 3)
     terminal-table (2.0.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
-    thread_safe (0.3.6)
     tilt (2.0.10)
     trollop (2.9.9)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-    tzinfo-data (1.2021.5)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2022.1)
       tzinfo (>= 1.0.0)
     unicode-display_width (1.8.0)
     wdm (0.1.1)
@@ -143,23 +123,25 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 2.3.8)
-  jekyll (~> 4.2, >= 4.1.1)
+  backports (~> 3.23)
+  bundler (~> 2.3.15)
+  faraday-retry
+  jekyll (~> 4.2.2, >= 4.1.1)
   jekyll-admin (~> 0.11.0)
-  jekyll-feed (~> 0.13.0)
+  jekyll-feed (~> 0.16.0)
   jekyll-gist (~> 1.5.0)
   jekyll-paginate (~> 1.1.0)
-  jekyll-seo-tag (~> 2.6.1)
+  jekyll-seo-tag (~> 2.8.0)
   jekyll-sitemap (~> 1.4.0)
   jgd (~> 1.12)
   kramdown
   puma
   rack
   rack-jekyll
-  tzinfo (~> 1.2)
+  tzinfo (~> 2.0)
   tzinfo-data
   wdm (~> 0.1.1)
   webrick (~> 1.7)
 
 BUNDLED WITH
-   2.3.8
+   2.3.15

README.md

@@ -36,34 +36,96 @@ or if you want to try fast :
 8. Happy Hacking your new site ! For Local changes you can clone locally.
 
 
-### Local Development Steps :
-To work locally, follow this commands. You might need to download and install [ruby (with devkit)](https://www.ruby-lang.org/downloads/) and [git](https://git-scm.com/downloads).
+## Local Development Steps :
 
-```sh
+### Clone Locally:
+
+```s
 $ git clone https://github.com/your_github_username/your_github_username.github.io.git
 $ cd your_github_username
-$ ruby -v
+```
+
+### For Windows :
+
+To work locally with windows machine, follow this commands. You might need to download and install [ruby (with devkit)](https://www.ruby-lang.org/en/downloads/) and [git](https://git-scm.com/downloads).
+
+```s
+$ ruby -v 
+(ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [universal.x86_64-darwin21])
+
 $ gem install jekyll bundler
+
 $ bundler -v
+Bundler version 2.3.15
+
 $ bundle update
-$ bundle exec jekyll -v
+
+$ bundle exec jekyll -v 
+jekyll 4.2.2
+
 $ bundle exec jekyll serve --livereload
 ```
 
 If you are using permission issues, running bundler:
 
-```sh
+```s
 $ sudo rm -rf _site
 $ bundle update
 $ bundle exec jekyll serve
 ```
 Start the server locally at http://127.0.0.1:4000/ or http://localhost:4000/
 
+### For MacOS :
+Run the following in your terminal :
+
+1. Install Homebrew
+
+`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
+
+2. Install churby and ruby-install with Homebrew
+
+`brew install chruby ruby-install`
+
+3. Install latest ruby version 
+
+`ruby-install ruby`
+
+4. This will take a few minutes, and once it’s done, configure your shell to automatically use chruby:
+
+```sh
+echo "source $(brew --prefix)/opt/chruby/share/chruby/chruby.sh" >> ~/.zshrc
+echo "source $(brew --prefix)/opt/chruby/share/chruby/auto.sh" >> ~/.zshrc
+echo "chruby ruby-3.1.1" >> ~/.zshrc
+```
+If you’re using Bash, replace *.zshrc* with *.bash_profile*.
+
+Quit and relaunch Terminal, then check that everything is working:
+
+`$ ruby -v`
+ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-darwin21]
+
+5. Install latest gems
+
+```s
+$ gem install jekyll bundler
+
+$ bundler -v
+Bundler version 2.3.15
+
+$ bundle update
+
+$ bundle exec jekyll -v 
+jekyll 4.2.2
+
+$ bundle exec jekyll serve --livereload
+```
+
+
 ### Security 
 
 We use codeQL and dependabot alerts for vulnerabality analysis & fixes.
 
-```sh
+```s
 $ bundle audit
 ```
 

devlopr.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "devlopr"
-  spec.version       = "0.4.6"
+  spec.version       = "0.4.9"
   spec.authors       = ["Sujay Kundu"]
   spec.email         = ["[email protected]"]
 
@@ -24,6 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "jekyll-gist", '~> 1.5.0'
   spec.add_runtime_dependency "jekyll-admin", '~> 0.11.0'
 
-  spec.add_development_dependency "bundler", "~> 2.2.29"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "bundler", "~> 2.3.15"
+  spec.add_development_dependency "rake", "~> 13.0"
 end