Update rspec, unit test and gemspec

maanavshah · maanavshah · commit 9b7a61bff1d6 · 2018-07-08T22:18:46.000+05:30
Updated simplecov and rspec coverage, unit test directory and gemspec files
diff --git a/.gitignore b/.gitignore
@@ -1,50 +1,11 @@
-*.gem
-*.rbc
-/.config
+/.bundle/
+/.yardoc
+/_yardoc/
 /coverage/
-/InstalledFiles
+/doc/
 /pkg/
 /spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
 /tmp/
 
-# Used by dotenv library to load environment variables.
-# .env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+# rspec failure tracking
+.rspec_status
diff --git a/.rspec b/.rspec
@@ -1 +1,2 @@
 --color
+--format documentation
diff --git a/.simplecov b/.simplecov
@@ -1,3 +1 @@
-SimpleCov.start do
-  add_group 'lib', 'lib'
-end
+SimpleCov.start
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.3
+  - 2.2.0
 before_install: gem install bundler -v 1.16.1
diff --git a/Gemfile b/Gemfile
@@ -1,8 +1,11 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/opensocket" }
+git_source(:github) { |_repo_name| 'https://github.com/opensocket' }
 
 # Specify your gem's dependencies in socketclusterclient.gemspec
 gemspec
 
 gem 'websocket-eventmachine-client'
+
+gem 'rspec', :require => false, :group => :test
+gem 'simplecov', :require => false, :group => :test
diff --git a/Gemfile.lock b/Gemfile.lock
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # socketcluster-client-ruby
 A Ruby client for socketcluster.io
 
+In `lib/socketclusterclient`, 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 . To experiment with that code, run `bin/console` for an interactive prompt.
+
 Refer below examples for more details.
 
 Overview
@@ -177,7 +179,7 @@ Implementing Pub-Sub via channels
 
 ```ruby
     # Get all subscribed channel
-    channels = socket.get_subscribed_channels
+    channels = socket.subscribed_channels
 ```
 
 #### Publishing an event on channel
diff --git a/Rakefile b/Rakefile
@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
diff --git a/bin/console b/bin/console
@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "socketclusterclient"
+require 'bundler/setup'
+require 'socketclusterclient'
 
 # 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.
@@ -10,5 +10,5 @@ require "socketclusterclient"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)
diff --git a/bin/setup b/bin/setup
@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here
diff --git a/lib/sc_client.rb b/lib/sc_client.rb
@@ -83,7 +83,7 @@ def set_auth_token(token)
   #
   #
   #
-  def get_subscribed_channels
+  def subscribed_channels
     @channels
   end
 
@@ -310,7 +310,7 @@ def unsubscribeack(channel, ack)
   #
   #
   def publish(channel, data)
-    @ws.send(get_publisher_object(channel, data, increment_cnt).to_json)
+    @ws.send(get_publish_object(channel, data, increment_cnt).to_json)
   end
 
   #
@@ -323,7 +323,7 @@ def publish(channel, data)
   # @return [<type>] <description>
   #
   def publishack(channel, data, ack)
-    @ws.send(get_publisher_object(channel, data, increment_cnt).to_json)
+    @ws.send(get_publish_object(channel, data, increment_cnt).to_json)
     @acks[@cnt] = [channel, ack]
   end
 
diff --git a/lib/socketclusterclient/data_models.rb b/lib/socketclusterclient/data_models.rb
@@ -73,9 +73,9 @@ def get_handshake_object(counter)
   # @param [String] data A data object
   # @param [Integer] counter A counter for a particular event
   #
-  # @return A publisher object
+  # @return A publish object
   #
-  def get_publisher_object(channel, data, counter)
+  def get_publish_object(channel, data, counter)
     OpenStruct.new(
       cid: counter,
       data: OpenStruct.new(
diff --git a/lib/socketclusterclient/reconnect.rb b/lib/socketclusterclient/reconnect.rb
@@ -29,7 +29,7 @@ def initialize_reconnect
   #
   #
   def set_reconnection_listener(reconnect_interval, max_reconnect_interval, reconnect_decay, max_attempts)
-    @reconnect_interval = (reconnect_interval > max_reconnect_interval) ? max_reconnect_interval : reconnect_interval
+    @reconnect_interval = reconnect_interval > max_reconnect_interval ? max_reconnect_interval : reconnect_interval
     @max_reconnect_interval = max_reconnect_interval
     @reconnect_decay = reconnect_decay
     @max_attempts = max_attempts
diff --git a/socketclusterclient.gemspec b/socketclusterclient.gemspec
@@ -1,32 +1,32 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'socketclusterclient/version'
 
 Gem::Specification.new do |spec|
   spec.name        = 'socketclusterclient'
   spec.version     = Socketclusterclient::VERSION
+  spec.authors     = ['Maanav Shah', 'Piyush Wani', 'Sachin Shinde']
+  spec.email       = %w[shahmaanav07@gmail.com piyushwww13@gmail.com sachinshinde7676@gmail.com]
+
   spec.platform    = Gem::Platform::RUBY
   spec.licenses    = ['MIT']
+
   spec.summary     = 'Ruby client for socketcluster'
-  spec.homepage    = 'https://socketcluster.io/'
   spec.description = 'A socketcluster client designed in ruby'
-  spec.email       = %w[shahmaanav07@gmail.com piyushwww13@gmail.com sachinshinde7676@gmail.com]
-  spec.authors     = ['Maanav Shah', 'Piyush Wani', 'Sachin Shinde']
+  spec.homepage    = 'https://socketcluster.io/'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency('bundler', '~> 1.16')
+  spec.add_development_dependency('rake', '~> 10.0')
+  spec.add_development_dependency('rspec', '~> 3.0')
+  spec.add_development_dependency('simplecov', '~> 0.16')
   spec.add_dependency('websocket-eventmachine-client', '~> 1.2')
-
 end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -1,9 +1,12 @@
-require "bundler/setup"
-require "socketclusterclient"
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+
+Bundler.require
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
+  config.example_status_persistence_file_path = '.rspec_status'
 
   # Disable RSpec exposing methods globally on `Module` and `main`
   config.disable_monkey_patching!
diff --git a/spec/unit/lib/data_models_spec.rb b/spec/unit/lib/data_models_spec.rb
diff --git a/spec/unit/lib/emitter_spec.rb b/spec/unit/lib/emitter_spec.rb
diff --git a/spec/unit/lib/parser_spec.rb b/spec/unit/lib/parser_spec.rb
diff --git a/spec/unit/lib/sc_client_spec.rb b/spec/unit/lib/sc_client_spec.rb
diff --git a/spec/unit/socketclusterclient_spec.rb b/spec/unit/socketclusterclient_spec.rb
