Merge pull request #2 from DannyBen/refactor/rubocop

Refactor with rubocop

Author: DannyBen

.github/workflows/test.yml

@@ -12,7 +12,7 @@ jobs:
       LC_ALL: en_US.UTF-8 # consistent sort order
 
     strategy:
-      matrix: { ruby: ['2.7', '3.0', '3.1'] }
+      matrix: { ruby: ['2.7', '3.0', '3.1', head] }
 
     steps:
     - name: Checkout code

.rubocop.yml

@@ -0,0 +1,38 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+inherit_gem:
+  rentacop: rentacop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7.0
+  Exclude:
+    - 'debug.rb'
+    - 'dev/**/*'
+
+# Allow methods that start with `get_` in some cases
+Naming/AccessorMethodName:
+  Exclude:
+    - 'spec/fixtures/**/*'
+
+# Prefer `receive` over `have_received`spies
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Allow multiple expectations per block
+RSpec/MultipleExpectations:
+  Max: 3
+
+# Allow calling `subject` explicitly
+RSpec/NamedSubject:
+  EnforcedStyle: named_only
+
+# Allow stubbing other `subject` methods
+RSpec/SubjectStub:
+  Enabled: false
+
+# Allow unnamed doubles
+RSpec/VerifiedDoubles:
+  Enabled: false
+

Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gem 'byebug'
 gem 'lp'

gtx.gemspec

@@ -1,25 +1,24 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'date'
 require 'gtx/version'
 
 Gem::Specification.new do |s|
   s.name        = 'gtx'
   s.version     = GTX::VERSION
-  s.date        = Date.today.to_s
-  s.summary     = "GTX Template Engine"
-  s.description = "Create templates that transpile to ERB"
-  s.authors     = ["Danny Ben Shitrit"]
+  s.summary     = 'GTX Template Engine'
+  s.description = 'Create templates that transpile to ERB'
+  s.authors     = ['Danny Ben Shitrit']
   s.email       = '[email protected]'
   s.files       = Dir['README.md', 'lib/**/*.*']
   s.homepage    = 'https://github.com/dannyben/gtx'
   s.license     = 'MIT'
-  s.required_ruby_version = ">= 2.7.0"
+  s.required_ruby_version = '>= 2.7.0'
 
   s.metadata = {
-    "bug_tracker_uri"   => "https://github.com/DannyBen/gtx/issues",
-    "changelog_uri"     => "https://github.com/DannyBen/gtx/blob/master/CHANGELOG.md",
-    "homepage_uri"      => 'https://github.com/dannyben/gtx',
-    "source_code_uri"   => 'https://github.com/dannyben/gtx',
+    'bug_tracker_uri'       => 'https://github.com/DannyBen/gtx/issues',
+    'changelog_uri'         => 'https://github.com/DannyBen/gtx/blob/master/CHANGELOG.md',
+    'homepage_uri'          => 'https://github.com/dannyben/gtx',
+    'source_code_uri'       => 'https://github.com/dannyben/gtx',
+    'rubygems_mfa_required' => 'true',
   }
 end

lib/gtx.rb

@@ -18,7 +18,8 @@ def render_file(path, context: nil, filename: nil)
   attr_reader :template, :filename
 
   def initialize(template, filename: nil)
-    @template, @filename = template, filename
+    @template = template
+    @filename = filename
   end
 
   def erb_source
@@ -34,7 +35,7 @@ def erb_source
   def erb
     ERB.new(erb_source, trim_mode: '-').tap { |a| a.filename = filename }
   end
-  
+
   def parse(context = nil)
     context ||= self
     context = context.instance_eval { binding } unless context.is_a? Binding
@@ -48,5 +49,4 @@ def eval_vars(string)
       .gsub(/\\\}\\\}/, '}}')
       .gsub(/\\\{\\\{/, '{{')
   end
-
 end

lib/gtx/version.rb

@@ -1,3 +1,3 @@
 class GTX
-  VERSION = "0.1.0"
+  VERSION = '0.1.0'
 end

spec/fixtures/mock_context.rb

@@ -0,0 +1,13 @@
+module MockContext
+  class One
+    def get_binding
+      binding
+    end
+  end
+
+  class Two
+    def report
+      'success'
+    end
+  end
+end

spec/gtx/gtx_spec.rb

@@ -2,86 +2,74 @@
 
 describe GTX do
   subject { described_class.new template }
+
   let(:context) { double user: 'admin' }
   let(:template) { "> some output\nruby_code = 'yes'\n= ruby_code" }
-  let(:example_path) { "examples/full.gtx" }
+  let(:example_path) { 'examples/full.gtx' }
 
   describe 'full example' do
     subject { described_class.load_file example_path }
 
-    it "generates the correct ERB source" do
-      expect(subject.erb_source).to match_approval("examples/full.erb")
+    it 'generates the correct ERB source' do
+      expect(subject.erb_source).to match_approval('examples/full.erb')
     end
 
-    it "generates the correct output" do
-      expect(subject.parse context).to match_approval("examples/full.txt")
+    it 'generates the correct output' do
+      expect(subject.parse context).to match_approval('examples/full.txt')
     end
   end
 
   describe '#erb_source' do
-    it "returns ERB code" do
-      expect(subject.erb_source).to match_approval("gtx/erb_source")
+    it 'returns ERB code' do
+      expect(subject.erb_source).to match_approval('gtx/erb_source')
     end
   end
 
   describe '#erb' do
-    it "returns ERB object" do
+    it 'returns ERB object' do
       expect(subject.erb).to be_an ERB
     end
   end
 
   describe '#parse' do
-    it "returns the parsed ERB output" do
+    it 'returns the parsed ERB output' do
       expect(subject.parse context).to match_approval('gtx/parse')
     end
 
-    context "on error" do
-      subject { described_class.load_file "spec/fixtures/error.gtx" }
+    context 'when an error occurs' do
+      subject { described_class.load_file 'spec/fixtures/error.gtx' }
 
-      it "registers the correct file and line number in the backtrace" do
+      it 'registers the correct file and line number in the backtrace' do
         expect { subject.parse }.to raise_error(ZeroDivisionError) do |e|
-          expect(e.backtrace.first).to include "spec/fixtures/error.gtx:18"
+          expect(e.backtrace.first).to include 'spec/fixtures/error.gtx:18'
         end
       end
     end
 
-    context "when a Binding object is passed instead of a regular object" do
-      let(:context) do 
-        module Context
-          class One
-            def get_binding; binding; end
-          end
-
-          class Two
-            def report; "success"; end
-          end
-        end
+    context 'when a Binding object is passed instead of a regular object' do
+      let(:context) { MockContext::One.new.get_binding }
+      let(:template) { '= Two.new.report' }
 
-        Context::One.new.get_binding
-      end
-
-      let(:template) { "= Two.new.report" }
-
-      it "uses the Binding object as is instead of re-binding it" do        
+      it 'uses the Binding object as is instead of re-binding it' do
         expect(subject.parse context).to match_approval('gtx/parse-binding')
       end
     end
   end
 
-  context "class methods" do
+  describe 'class methods' do
     subject { described_class }
 
-    describe "::render" do
-      it "returns a parsed result" do
+    describe '::render' do
+      it 'returns a parsed result' do
         expect(subject.render template, context: context).to match_approval('gtx/parse')
       end
     end
 
-    describe "::load_file" do
+    describe '::load_file' do
       subject { described_class.load_file example_path }
 
-      it "returns a GTX object" do
-        expect(subject).to be_a GTX
+      it 'returns a GTX object' do
+        expect(subject).to be_a described_class
       end
 
       it "loads the file's content to the GTX object" do
@@ -93,15 +81,14 @@ def report; "success"; end
       end
     end
 
-    describe "::render_file" do
+    describe '::render_file' do
       let(:gtx_double) { double :parse }
 
-      it "is a shortcut to ::load_file(path).parse context" do
-        expect(subject).to receive(:load_file).with(example_path, filename: nil).and_return(gtx_double)
+      it 'is a shortcut to ::load_file(path).parse context' do
+        allow(subject).to receive(:load_file).with(example_path, filename: nil).and_return(gtx_double)
         expect(gtx_double).to receive(:parse).with(context)
         subject.render_file example_path, context: context
       end
     end
   end
-
 end

spec/spec_helper.rb

@@ -13,6 +13,8 @@
 ENV['COLUMNS'] = '80'
 ENV['LINES'] = '30'
 
+require_relative 'fixtures/mock_context'
+
 RSpec.configure do |c|
   c.strip_ansi_escape = true
 end