bake-modernize 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fbae11851db3723d7447541f71edf6be25cf9628238a4f0448cc92452a297cd
-  data.tar.gz: b44def12e5c6c99e1eeb48cf032ca7cf5218a4807a29653c162357a6c3c6d2bf
+  metadata.gz: 618ddd5d5d14fae0b60bdcb99792041860923d6c8d427a4c4434ee6647510cdd
+  data.tar.gz: d7fe3f033d7740faba648e91f2350977cc486f48ec2c2e2bdb557311c31a594d
 SHA512:
-  metadata.gz: 585051b328bbe211011db904b5b6093fe73e1a5416078f4c0881b6a586c9f56d3cb680df4a91a338b1bdef029e388d5102fbd74270d766ae6d1f620f83c70a49
-  data.tar.gz: e262f334b3ffda2e56f73cb5f508e9e3fe2b39df8714b8788b22bf1933303cf388662fa06a9c5c0a1dad186feecce7afa9470872a7e8c1fc011ec80ac3372035
+  metadata.gz: '01387668d332dce58fd867a0727a125e4fe5f8d84a28f53c61a946c48ebe06b06ff7cc7db6cbc986b2b7a7f16503289bdfa58e26cf1139eb3f9489ad9fb759a5'
+  data.tar.gz: a1f680d832d37a4591f2c71793384f66b71d54efceecd8a7c9e963b7348a199523bd26d16057880626bd33b14ade10b25b10e0901b86751e640a9b1eb9810951

data/bake/modernize.rb

@@ -1,4 +1,4 @@
 
 def modernize
-	call('modernize:actions', 'modernize:gemfile', 'modernize:gemspec')
+	call('modernize:actions', 'modernize:editorconfig', 'modernize:gemfile', 'modernize:gemspec')
 end

data/bake/modernize/actions.rb

@@ -1,5 +1,7 @@
 
 require 'bake/modernize'
+require 'rugged'
+require 'markly'
 
 def actions
 	update(root: Dir.pwd)
@@ -14,4 +16,58 @@ def update(root:)
 	
 	template_root = Bake::Modernize.template_path_for('actions')
 	Bake::Modernize.copy_template(template_root, root)
+	
+	readme_path = File.expand_path("README.md", root)
+	repository_url = self.repository_url(root)
+	self.update_badges(readme_path, repository_url)
+end
+
+private
+
+def repository_url(root)
+	repository = Rugged::Repository.discover(root)
+	git_url = repository.remotes['origin'].url
+	
+	if match = git_url.match(/@(?<url>.*?):(?<path>.*?)(\.git)?\z/)
+		return "https://#{match[:url]}/#{match[:path]}"
+	end
+end
+
+def badge_for(repository_url = self.repository_url)
+	"[![Development Status](#{repository_url}/workflows/Development/badge.svg)](#{repository_url}/actions?workflow=Development)"
+end
+
+def badge?(node)
+	return false unless node.type == :link
+	return node.all?{|child| child.type == :image}
+end
+
+def badges?(node)
+	node.any?{|child| badge?(child)}
+end
+
+def update_badges(readme_path, repository_url)
+	root = Markly.parse(File.read(readme_path))
+	
+	node = root.first_child
+	
+	# Skip heading:
+	node = node.next if node.type == :header
+	
+	replacement = Markly.parse(badge_for(repository_url))
+	
+	# We are looking for the first paragraph which contains only links, which contain one image.
+	while node
+		if badges?(node)
+			node = node.replace(replacement.first_child)
+			break
+		elsif node.type == :header
+			node.insert_before(replacement.first_child)
+			break
+		end
+		
+		node = node.next
+	end
+	
+	File.write(readme_path, root.to_markdown(width: 0))
 end

data/bake/modernize/editorconfig.rb

@@ -0,0 +1,17 @@
+
+require 'bake/modernize'
+
+def editorconfig
+	update(root: Dir.pwd)
+end
+
+def update(root:)
+	editorconfig_path = File.expand_path(".editorconfig", root)
+	
+	if File.exist?(editorconfig_path)
+		FileUtils.rm_rf(editorconfig_path)
+	end
+	
+	template_root = Bake::Modernize.template_path_for('editorconfig')
+	Bake::Modernize.copy_template(template_root, root)
+end

data/bake/modernize/gemspec.rb

@@ -70,7 +70,7 @@ def update(path: self.default_gemspec_path, output: $stdout)
 	end
 	
 	if required_ruby_version = spec.required_ruby_version
-		output.puts
+		output.puts "\t"
 		output.puts "\tspec.required_ruby_version = #{required_ruby_version.to_s.inspect}"
 	end
 	
@@ -107,7 +107,7 @@ def directory_glob_for(spec, paths = spec.files)
 		end
 	end
 	
-	return "Dir['{#{directories.keys.join(',')}}/**/*', base: __dir__]"
+	return "Dir.glob('{#{directories.keys.join(',')}}/**/*', File::FNM_DOTMATCH, base: __dir__)"
 end
 
 def format_dependency(dependency)
@@ -155,7 +155,7 @@ end
 GITHUB_PROJECT = /github.com\/(?<account>.*?)\/(?<project>.*?)\/?/
 
 def detect_funding_uri(spec)
-	if match = spec.homepage.match(GITHUB_PROJECT)
+	if match = spec.homepage&.match(GITHUB_PROJECT)
 		account = match[:account]
 		
 		funding_uri = "https://github.com/sponsors/#{account}/"

data/lib/bake/modernize/version.rb

@@ -20,6 +20,6 @@
 
 module Bake
 	module Modernize
-		VERSION = "0.1.2"
+		VERSION = "0.3.0"
 	end
 end

data/template/actions/.github/workflows/development.yml

@@ -0,0 +1,46 @@
+name: Development
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ${{matrix.os}}-latest
+    continue-on-error: ${{matrix.experimental}}
+    
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+          - macos
+        
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+        
+        experimental: [false]
+        env: [""]
+        
+        include:
+          - os: ubuntu
+            ruby: truffleruby
+            experimental: true
+          - os: ubuntu
+            ruby: jruby
+            experimental: true
+          - os: ubuntu
+            ruby: head
+            experimental: true
+    
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+    
+    - name: Install dependencies
+      run: ${{matrix.env}} bundle install --without development
+    
+    - name: Run tests
+      timeout-minutes: 5
+      run: ${{matrix.env}} bundle exec rspec

data/template/editorconfig/.editorconfig

@@ -0,0 +1,5 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2

data/template/readme/README.md

@@ -0,0 +1,47 @@
+# #{title}
+
+#{description}
+
+[![Development](https://github.com/#{account}/#{project}/workflows/Development/badge.svg)](https://github.com/#{account}/#{project}/actions?workflow=Development)
+
+## Motivation
+
+#{motivation}
+
+## Usage
+
+Please see the [project documentation](https://#{account}.github.io/#{project}/) or run it locally using `bake utopia:project:serve`.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2020, by [Samuel G. D. Williams](http://www.codeotaku.com).
+
+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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bake-modernize
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2020-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: markly
+  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'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  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'
 - !ruby/object:Gem::Dependency
   name: bake-bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,24 +94,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - bake/modernize.rb
 - bake/modernize/actions.rb
+- bake/modernize/editorconfig.rb
 - bake/modernize/gemfile.rb
 - bake/modernize/gemspec.rb
 - lib/bake/modernize.rb
 - lib/bake/modernize/version.rb
+- template/actions/.github/workflows/development.yml
+- template/editorconfig/.editorconfig
+- template/readme/README.md
 homepage: https://github.com/ioquatix/bake-modernize
 licenses:
 - MIT
 metadata:
   funding_uri: https://github.com/sponsors/ioquatix/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Automatically modernize parts of your project/gem.
 test_files: []