syntax_tree-no_alignment 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ccb7bc65e859b8f3b9af38319dd3f72c844e2032e44f63c3139e36fdcb0803d6
+  data.tar.gz: 942fb4860eda08e30f7319e908a6f2d5413ccb5c0d3c5591fbc24907992ec71f
+SHA512:
+  metadata.gz: 45bd358fdb78066412eac2f4e12e8de09da191cc3796342645759d40fda809df44a45b41a90bac50f80b3818b894289fe5ffd272126c10ba5f0f72e59ad3f87e
+  data.tar.gz: f5f5c0059f2848557e95f792e21577518b979f68cc17c8ffc0366ac1531e5aad904f250fbd4219ea72aef6297c98c3276f6dc6266953af3757d4164dbb314005

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_gem:
+  syntax_tree: config/rubocop.yml
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Tomasz Szczęśniak-Szlagowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# SyntaxTree plugin: no_alignment
+
+SyntaxTree gem can format your Ruby code and I think it's pretty good at that!
+Despite not having many configuration options, it does have a plugin system 
+for people who want to change a thing or two in its behavior.
+
+There are 2 common ways to [align arguments in a multiline method call](rubocop_rule):
+
+- align them to the first argument
+- use fixed indentation
+
+SyntaxTree uses both, depending on whether you use parentheses or not:
+
+```ruby
+with_parens(
+  "lorem ipsum",
+  "dolor sit amet",
+  "consectetur adipiscing elit"
+)
+
+without_parens "lorem ipsum",
+               "dolor sit amet",
+               "consectetur adipiscing elit"
+```
+
+Parens-less syntax is often used for DSLs, which is probably why it gets this special treatment.
+
+This plugin will remove this exception and make all indentation fixed:
+
+```ruby
+with_this_plugin "lorem ipsum",
+  "dolor sit amet",
+  "consectetur adipiscing elit"
+```
+
+[rubocop_rule]: https://docs.rubocop.org/rubocop/cops_layout.html#layoutargumentalignment
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add syntax_tree-no_alignment
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install syntax_tree-no_alignment
+
+## Usage
+
+Example:
+```
+stree write --plugins=no_alignment lib/**/*.rb
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/spect88/syntax_tree-no_alignment.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+require "syntax_tree/rake_tasks"
+stree_config =
+  proc do |t|
+    t.source_files =
+      FileList[%w[Gemfile Rakefile lib/**/*.rb test/**/*.rb *.gemspec]]
+  end
+SyntaxTree::Rake::CheckTask.new(&stree_config)
+SyntaxTree::Rake::WriteTask.new(&stree_config)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+desc "Run all code checks"
+task check: %i[rubocop stree:check test]
+
+desc "Run all automated fixes"
+task fix: %i[stree:write rubocop:autocorrect_all]
+
+task default: :check

data/lib/syntax_tree/no_alignment/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module NoAlignment
+    VERSION = "0.1.0"
+  end
+end

data/lib/syntax_tree/no_alignment.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require_relative "no_alignment/version"
+
+module SyntaxTree
+  module NoAlignment
+    module CommandPatch
+      def align(q, node, &block)
+        q.text(" ")
+
+        if node.arguments.is_a?(Args) && node.arguments.parts.size == 1 &&
+             skip_indent?(arguments.parts.first)
+          block.call
+          return
+        end
+
+        q.indent(&block)
+      end
+
+      def skip_indent?(argument)
+        (argument.is_a?(BareAssocHash) && argument.assocs.size == 1) ||
+          argument.is_a?(CallNode) || AssignFormatting.skip_indent?(argument)
+      end
+    end
+
+    module CommandCallPatch
+      def argument_alignment(_q, _doc)
+        %w[to not_to to_not].include?(message.value) ? 0 : 2
+      end
+    end
+  end
+end
+
+SyntaxTree::Command.prepend(SyntaxTree::NoAlignment::CommandPatch)
+SyntaxTree::CommandCall.prepend(SyntaxTree::NoAlignment::CommandCallPatch)

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: syntax_tree-no_alignment
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomasz Szczęśniak-Szlagowski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: syntax_tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Syntax Tree aligns arguments of parens-less method calls. This plugin
+  disables that behavior.
+email:
+- spect88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/syntax_tree/no_alignment.rb
+- lib/syntax_tree/no_alignment/version.rb
+homepage: https://github.com/spect88/syntax_tree-no_alignment
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/spect88/syntax_tree-no_alignment
+  source_code_uri: https://github.com/spect88/syntax_tree-no_alignment
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A Syntax Tree plugin disabling argument alignment
+test_files: []