code_optimization 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 443e6712d40380b5a80cae0be739960e1dfd79e2b11c950bc05ec2f95f855fa0
-  data.tar.gz: e80c395a83594fe217f70cc766fd2a3113fa730845c1782a4383a62a87ba55ee
+  metadata.gz: 7eda2d81c66f83071573ed4fa2ff6e617ceb91d50d5bbc9f905ddea79309c9fb
+  data.tar.gz: 2c6bdb4f057700f039bc2e863ea3fa6df8d54affb62f021311dbdc14dc225af8
 SHA512:
-  metadata.gz: e9598487951e2a633678f2df41c46307d6f614246c22289df2576c2636ec2e976e1750ab1af8471ae3e9db97104751de9bf592b3d613e63412d2fdf4da2702d0
-  data.tar.gz: e201e36f2cb4b4b57f4a63fde67201e0cdd6b3b469a6ed442e0442643ff21843198b58071ad8d5ec1bb99d3095ea89f905f2dc7c206a940492da809eaaa2dd47
+  metadata.gz: c5c3928ca5fb83b6505517b87d58d968cfc9c2bf098bdab2c25ea14de9f34add74cdebaeb411ea478cae1b882fa907fcecebef8eae32d982f2715cedf9233646
+  data.tar.gz: 7ccde5b1034dc456ce210f47abe1660812ee49189e8692bd84e993a2ae45a7228760144d3bd567b97681f42aae918b5e85bd51bf9e0aa6ba0bfd53f4a8a1a788

data/Gemfile.lock

@@ -0,0 +1,153 @@
+PATH
+  remote: .
+  specs:
+    code_optimization (0.1.1)
+      brakeman
+      bullet
+      rack-mini-profiler
+      rails_best_practices
+      rubocop
+      rubycritic
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    brakeman (4.8.2)
+    bullet (6.1.0)
+      activesupport (>= 3.0.0)
+      uniform_notifier (~> 1.11)
+    code_analyzer (0.5.2)
+      sexp_processor
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.1.6)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    flay (2.12.1)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.6.4)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    json (2.3.1)
+    kwalify (0.7.2)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    minitest (5.14.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    path_expander (1.1.0)
+    psych (3.1.0)
+    public_suffix (4.0.5)
+    rack (2.2.3)
+    rack-mini-profiler (2.0.2)
+      rack (>= 1.2.0)
+    rails_best_practices (1.20.0)
+      activesupport
+      code_analyzer (>= 0.5.1)
+      erubis
+      i18n
+      json
+      require_all (~> 3.0)
+      ruby-progressbar
+    rainbow (3.0.0)
+    rake (13.0.1)
+    reek (6.0.1)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.8, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (1.7.1)
+    require_all (3.0.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.14.2)
+      sexp_processor (~> 4.9)
+    rubycritic (4.5.1)
+      flay (~> 2.8)
+      flog (~> 4.4)
+      launchy (>= 2.0.0)
+      parser (>= 2.6.0)
+      rainbow (~> 3.0)
+      reek (~> 6.0, < 7.0)
+      ruby_parser (~> 3.8)
+      simplecov (>= 0.17.0)
+      tty-which (~> 0.4.0)
+      virtus (~> 1.0)
+    sexp_processor (4.15.0)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thread_safe (0.3.6)
+    tty-which (0.4.2)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    uniform_notifier (1.13.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    zeitwerk (2.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  code_optimization!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -1,8 +1,16 @@
 # CodeOptimization
 
-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/code_optimization`. To experiment with that code, run `bin/console` for an interactive prompt.
+The best way to write a code called as code optimization. The best ways are ruby styleguide, rails styleguide, code reusability, without code duplication, without security vulnerabilities and without N+1 queries. The above each and every best ways are have some libraries.
 
-TODO: Delete this and the text above, and describe your gem
+## Combination Of Below Gems
+
+1. OVERCOMMIT(Git Hook Manager)
+2. RUBOCOP(STATIC CODE ANALYSIS)
+3. BULLET(N+1 Query)
+4. BRAKEMAN(SECURITY SCANNER FOR ROR APPLICATION)
+5. Rack Mini profiler(Middleware that displays speed badge)
+6. Rails Best Practises(Rails Code Analysis Tool)
+7. RubyCritic(Ruby Code quality reporter)
 
 ## Installation
 
@@ -19,6 +27,10 @@ And then execute:
 Or install it yourself as:
 
     $ gem install code_optimization
+    
+## SETUP Details are Below
+
+[Code Optimization Document](https://github.com/honestveera/code_optimization/blob/master/code_optimization.md).
 
 ## Usage
 
@@ -32,7 +44,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/code_optimization. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/honestveera/code_optimization. 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
 

data/code_optimization.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_dependency "brakeman"
   spec.add_dependency "bullet"

data/code_optimization.md

@@ -0,0 +1,97 @@
+# CODE OPTIMIZATION
+
+The best way to write a code called as code optimization. The best ways is ruby styleguide, rails styleguide, code reusability, without code duplication, without security vulnerabilities and without N+1 queries. The above each and every best ways are have some libraries.
+
+# Installation
+
+Using Bundler:
+
+    group :development do
+      gem 'brakeman' # Security Analysis Tool
+      gem 'bullet' # Find N+1 Queries
+      gem 'overcommit' # Manage and configure Git hooks.
+      gem 'rails_best_practices' # Rails Code Analysis Tool
+      gem 'rack-mini-profiler' #Query Loading
+      gem 'rubocop' # Ruby Static Code Analyser #https://github.com/rubocop-hq/rubocop/edit/master/config/default.yml
+      gem 'rubycritic' # Code Reusability and Find Code duplications#
+    end
+
+# OVERCOMMIT(Git Hook Manager)
+
+1.  bundle install
+2.  overcommit --sign
+3.  git add file1,file2,file3
+4.  git commit -m "Test message"
+5.  Please check below messages are coming or not
+
+Running pre-commit hooks: Example
+
+    Analyze with RailsBestPractices..................[RailsBestPractices] OK
+    Analyze with RuboCop........................................[RuboCop] OK
+    ✓ All pre-commit hooks passed
+    Running commit-msg hooks
+    Check text width..........................................[TextWidth] OK
+    Check subject capitalization.....................[CapitalizedSubject] WARNING
+    
+    Subject should start with a capital letter
+    Check subject line................................[SingleLineSubject] OK
+    Check for trailing periods in subject................[TrailingPeriod] OK
+ 
+    ⚠ All commit-msg hooks passed, but with warnings
+
+# RUBOCOP(STATIC CODE ANALYSIS)
+
+1. `rubocop .` (It will scan whole projects *.rb) 
+2. `rubocop file_path` (Analyse only particular .rb file).  
+3.  How to auto_correct particular file?
+
+     `rubocop file_path ----safe-auto-correct`
+
+# BULLET(N+1 Query)
+1.Please config this for below `config/environments/development.rb`
+
+     config.after_initialize do
+        Bullet.enable = true
+        Bullet.alert = true
+        Bullet.bullet_logger = true
+        Bullet.console = true
+        Bullet.growl = true
+        Bullet.rails_logger = true
+      end
+      
+# BRAKEMAN(SECURITY SCANNER FOR ROR APPLICATION)
+1. Please chack all useful commands of brakeman
+
+       brakeman
+       brakeman -o output_filename.html [It will return output for CSV,JSON OR HTML]
+       brakeman -t SQL,ValidationRegex [Only run a certain set of tests]
+       brakeman -x DefaultRoutes,Redirect [Can skip particular validation]
+       brakeman --skip-files file1,/path1/,path2/ [Do skip certain file OR Directory]
+       brakeman --compare old_report.json [We can compare old results with new results]
+       Warning Types: https://github.com/presidentbeef/brakeman/tree/master/docs/warning_types
+       
+# Rack Mini profiler(Middleware that displays speed badge)
+1. Middleware that displays speed badge for every html page
+2. Designed to work both in production and in development.
+
+# Rails Best Practises(Rails Code Analysis Tool)
+1. Please check the useful commands
+2. It will check rails principle COC(convention over configuration) and DRY(Dont repeat yourself)
+
+        rails_best_practises --help
+        rails_best_practises .
+
+# RubyCritic(Ruby Code quality reporter)
+1.Code Reusability and Find Code duplications.This is a combination of Flay,Flog and Reek.
+
+Reek - Reek is a tool that examines Ruby classes, modules and methods and reports any Code Smells it finds.
+Flay - Flay analyzes code for structural similarities.
+Flog - Flog reports the most tortured code in an easy to read pain report
+
+    rubycritic
+    rubycritic lib/foo.rb
+    (OR)
+    reek 
+    flay
+    flog
+

data/lib/code_optimization/version.rb

@@ -1,3 +1,3 @@
 module CodeOptimization
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_optimization
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Honestraj Kandhasamy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2020-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -151,12 +151,14 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - code_optimization.gemspec
+- code_optimization.md
 - lib/code_optimization.rb
 - lib/code_optimization/version.rb
 homepage: https://rubygems.org/gems/code_optimization