Small code cleanup / update (WIP)

.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  DisplayCopNames: true
+  Exclude: 
+    - Gemfile
+    - ./*.gemspec
+    - ./bin/**/*
+    - ./test/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Lint/Debugger:
+  Enabled: false

.ruby-version

@@ -0,0 +1 @@
+2.4.0

Gemfile

@@ -1,14 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-# Declare your gem's dependencies in swagger_engine.gemspec.
-# Bundler will treat runtime dependencies like base dependencies, and
-# development dependencies will be added by default to the :development group.
-gemspec
-
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
+source 'https://rubygems.org'
 
-# To use debugger
-# gem 'debugger'
+gemspec

Gemfile.lock

@@ -6,12 +6,34 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.3.0)
+    coderay (1.1.1)
+    method_source (0.8.2)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.2.1)
+    rubocop (0.48.1)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    slop (3.6.0)
+    unicode-display_width (1.2.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  pry
+  rubocop
   swagger_engine!
 
 BUNDLED WITH
-   1.11.2
+   1.14.6

README.md

@@ -1,12 +1,6 @@
-# LOOKING FOR MAINTAINER
-
-I'm sorry but I can't maintain this project anymore.
-
-If you want to maintain this project, contact me (batdevis[at]gmail.com) and I will transfer the ownership.
-
 # SwaggerEngine
 
-Include [swagger-ui](https://github.com/swagger-api/swagger-ui) as rails engine.
+Include [swagger-ui](https://github.com/swagger-api/swagger-ui) as Rails engine.
 
 ## Swagger specifications
 
@@ -40,7 +34,7 @@ authenticate :user, lambda { |u| u.admin? } do
 end
 ```
 
-#### Basic http auth
+#### Basic HTTP Auth
 
 Set username and password in `config/initializers/swagger_engine.rb`:
 
@@ -53,7 +47,7 @@ end
 
 ## Configure
 
-### Json files
+### JSON files
 
 Set the path of your json files in a initializer:
 
@@ -69,9 +63,9 @@ end
 ```
 `lib/swagger/` is a good place to place them..
 
-### Edit your json files
+### Edit your JSON files
 
-Use [Swagger editor](https://github.com/swagger-api/swagger-editor).
+Use [Swagger Editor](https://github.com/swagger-api/swagger-editor).
 
 ## License
 
@@ -81,4 +75,4 @@ This project rocks and uses MIT-LICENSE.
 
 [Rawfish](http://rawfishindustries.com)
 
-[![Rawfish Logo](http://rawfishindustries.com/wp-content/uploads/2015/03/logo_rawfish_WEB.jpg)](http://rawfishindustries.com)
+[![Rawfish Logo](http://rawfishindustries.com/wp-content/uploads/2016/07/rawfish-logo-black.png)](http://rawfishindustries.com)

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,9 +16,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -28,5 +27,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

app/controllers/swagger_engine/application_controller.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module SwaggerEngine
   class ApplicationController < ActionController::Base
-
     before_filter :authenticate
 
     protected
+
     def authenticate
-      if SwaggerEngine.configuration.admin_username
-        authenticate_or_request_with_http_basic do |username, password|
-          username == SwaggerEngine.configuration.admin_username && password == SwaggerEngine.configuration.admin_password
-        end
+      return unless SwaggerEngine.configuration.admin_username
+
+      authenticate_or_request_with_http_basic do |username, password|
+        username == SwaggerEngine.configuration.admin_username \
+            && password == SwaggerEngine.configuration.admin_password
       end
     end
-
   end
 end

app/controllers/swagger_engine/swaggers_controller.rb

@@ -1,4 +1,6 @@
-require_dependency "swagger_engine/application_controller"
+# frozen_string_literal: true
+
+require_dependency 'swagger_engine/application_controller'
 
 module SwaggerEngine
   class SwaggersController < ApplicationController
@@ -7,23 +9,34 @@ class SwaggersController < ApplicationController
     before_filter :load_json_files
 
     def index
-      redirect_to swagger_path(@json_files.first[0]) if ( @json_files.size == 1 )
+      redirect_to swagger_path(@json_files.first[0]) if @json_files.size == 1
     end
 
     def show
       respond_to do |format|
-        format.html { 
-          @swagger_json_url = swagger_path(params[:id], format: :json)
-        }
-        format.json { 
-          send_file @json_files[params[:id].to_sym], type: 'application/json', disposition: 'inline'
-        }
+        format.html { show_html }
+        format.json { show_json }
       end
     end
 
     private
+
+    def show_html
+      @swagger_json_url = swagger_path(params[:id], format: :json)
+    end
+
+    def show_json
+      send_file(
+        @json_files[params[:id].to_sym],
+        type: 'application/json',
+        disposition: 'inline'
+      )
+    end
+
     def load_json_files
-      @json_files ||= SwaggerEngine.configuration.json_files || { default: "#{Rails.root}/lib/swagger_engine/swagger.json" }
+      @json_files ||= SwaggerEngine.configuration.json_files || {
+        default: "#{Rails.root}/lib/swagger_engine/swagger.json"
+      }
     end
   end
 end

app/helpers/swagger_engine/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerEngine
   module ApplicationHelper
   end

app/helpers/swagger_engine/swagger_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerEngine
   module SwaggerHelper
   end

bin/rails

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
 
 ENGINE_ROOT = File.expand_path('../..', __FILE__)

config/routes.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 SwaggerEngine::Engine.routes.draw do
-  resources :swaggers, only: [:index, :show]
+  resources :swaggers, only: %i[index show]
   root to: 'swaggers#index'
 end

lib/swagger_engine.rb

@@ -1,4 +1,6 @@
-require "swagger_engine/engine"
+# frozen_string_literal: true
+
+require 'swagger_engine/engine'
 
 module SwaggerEngine
 end

lib/swagger_engine/engine.rb

@@ -1,21 +1,19 @@
+# frozen_string_literal: true
+
 module SwaggerEngine
   class Engine < ::Rails::Engine
     isolate_namespace SwaggerEngine
 
-    #https://gist.github.com/parndt/11381872
-=begin
-    initializer "swagger_engine.assets.precompile", group: :all do |app|
-      app.config.assets.precompile += ['swagger_engine/print.css', 'swagger_engine/reset.css']
-    end
-=end
+    # https://gist.github.com/parndt/11381872
     config.to_prepare do
-      Rails.application.config.assets.precompile += ['swagger_engine/print.css', 'swagger_engine/reset.css']
+      Rails.application.config.assets.precompile += %w[
+        swagger_engine/print.css swagger_engine/reset.css
+      ]
     end
-
   end
 
   class Configuration
-    #[{ default: "swagger.json" }]
+    # [{ default: "swagger.json" }]
     attr_accessor :json_files
     attr_accessor :admin_username
     attr_accessor :admin_password
@@ -25,11 +23,12 @@ class << self
   end
 
   module_function
+
   def configuration
     @configuration ||= Configuration.new
   end
 
   def configure
     yield(configuration)
   end
- end
+end

lib/swagger_engine/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerEngine
-  VERSION = "0.0.3"
+  VERSION = '0.0.3'
 end

lib/tasks/swagger_engine_tasks.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # desc "Explaining what the task does"
 # task :swagger_engine do
 #   # Task goes here

swagger_engine.gemspec

@@ -1,19 +1,24 @@
-$:.push File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 
 # Maintain your gem's version:
-require "swagger_engine/version"
+require 'swagger_engine/version'
 
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
-  s.name        = "swagger_engine"
+  s.name        = 'swagger_engine'
   s.version     = SwaggerEngine::VERSION
-  s.authors     = ["batdevis"]
-  s.email       = ["[email protected]"]
-  s.homepage    = "https://github.com/batdevis/swagger_engine"
-  s.summary     = "Mount swagger-ui as rails engine."
-  s.description = "Api docs inside your rails project."
-  s.license     = "MIT"
+  s.authors     = ['batdevis']
+  s.email       = ['[email protected]']
+  s.homepage    = 'https://github.com/batdevis/swagger_engine'
+  s.summary     = 'Mount swagger-ui as rails engine.'
+  s.description = 'Api docs inside your rails project.'
+  s.license     = 'MIT'
+
+  s.add_development_dependency('pry')
+  s.add_development_dependency('rubocop')
 
-  s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
-  s.test_files = Dir["test/**/*"]
+  s.files = Dir['{app,config,db,lib}/**/*', 'MIT-LICENSE', 'Rakefile', 'README.rdoc']
+  s.test_files = Dir['test/**/*']
 end

test/controllers/swagger_engine/swagger_controller_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module SwaggerEngine

test/dummy/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 

test/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.

test/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 module ApplicationHelper
 end

test/dummy/bin/bundle

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 load Gem.bin_path('bundler', 'bundle')

test/dummy/bin/rails

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
+# frozen_string_literal: true
+
+APP_PATH = File.expand_path('../../config/application', __FILE__)
 require_relative '../config/boot'
 require 'rails/commands'

test/dummy/bin/rake

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require_relative '../config/boot'
 require 'rake'
 Rake.application.run

test/dummy/config.ru

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Rails.application