fastlane-plugin-changelog 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57b4471d6ae10ef7b6da62051f240fb79d9e427f
-  data.tar.gz: 2b694ab107d07ad643185320131bf20590b04707
+  metadata.gz: 217045bc188429e310a1e0a6c5733c0ff8dcab0a
+  data.tar.gz: b861687d566ac30feac7866f2b1273d09e6c891b
 SHA512:
-  metadata.gz: f00afaa4410d6b32a8ba12974983f7f5e3c7a53486d58f07a7f5a4bec44dbcddf9b6e055e96c8d2e5afd298d0f5624de02e156a07fa1da6b8bdfb74991d410d8
-  data.tar.gz: 01ef33dd468b606a62c224381fb68745fbea6743729fdb129fcc7eb9aaa4bb5e07696ce94684d75e721c81b97ea17065e104812ba47f79627792505af1bfdaf4
+  metadata.gz: 704b66ac13237ca0772114f88053978886e8e4960620bbf6b8e408efee3da2c58d836c63c01ba113d3403786f2420ba858b71f728b1024fbf6523e59d1d1fec6
+  data.tar.gz: 8da58cd64910ec0d72bfdc15382469228088069c3cdc594290cc2253da89672e281581e281aa0d6a28062fceabd1b7a09e2321ab6545d9f879d104f9543f5a39

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Pavel Procházka <pprochazka72@gmail.com>
+Copyright (c) 2018 Pavel Procházka <pprochazka72@gmail.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

data/lib/fastlane/plugin/changelog.rb

@@ -2,69 +2,11 @@ require 'fastlane/plugin/changelog/version'
 
 module Fastlane
   module Changelog
-    CHANGELOG_PATH = './CHANGELOG.md'
-    DEFAULT_CHANGELOG = '# Change Log
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
-
-## [Unreleased]
-### Added
-- Your awesome new feature'
-
     # Return all .rb files inside the "actions" and "helper" directory
     def self.all_classes
       Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
     end
 
-    # Offer user to setup CHANGELOG.md file in project folder (unless it already exists)
-    def self.setup_changelog
-      unless has_changelog?
-        if FastlaneCore::UI.confirm('Your project folder does not have CHANGELOG.md - do you want to create one now?')
-          create_changelog
-
-          FastlaneCore::UI.message('Changelog plugin can automaticaly create a link for comparison between two tags (see https://github.com/pajapro/fastlane-plugin-changelog#--stamp_changelog)')
-          if FastlaneCore::UI.confirm('Do you want to create links for comparing tags?')
-            repo_url = FastlaneCore::UI.input('Enter your GitHub or Bitbucket repository URL (e.g.: https://github.com/owner/project or https://bitbucket.org/owner/project):')
-            create_comparison_link(repo_url)
-          else
-            write_to_changelog(DEFAULT_CHANGELOG)
-          end
-        end
-      end
-    end
-
-    # Does CHANGELOG.md exists in project folder?
-    def self.has_changelog?
-      File.exist?(CHANGELOG_PATH)
-    end
-
-    # Create CHANGELOG.md file
-    def self.create_changelog
-      FileUtils.touch 'CHANGELOG.md'
-    end
-
-    # Create a link for tag comparison
-    def self.create_comparison_link(repo_url)
-      if repo_url.start_with?('https://github.com')
-        output = DEFAULT_CHANGELOG + "\n\n[Unreleased]: #{repo_url}/compare/master...HEAD"
-        write_to_changelog(output)
-      elsif repo_url.start_with?('https://bitbucket.org')
-        output = DEFAULT_CHANGELOG + "\n\n[Unreleased]: #{repo_url}/compare/master..HEAD"
-        write_to_changelog(output)
-      else
-        FastlaneCore::UI.error('Unknown repository host')
-        FastlaneCore::UI.message('Creating CHANGELOG.md without links for comparing tags')
-        write_to_changelog(DEFAULT_CHANGELOG)
-      end
-    end
-
-    # Write given content to CHANGELOG.md
-    def self.write_to_changelog(changelog)
-      File.open(CHANGELOG_PATH, 'w') { |f| f.write(changelog) }
-      FastlaneCore::UI.success('Successfuly created CHANGELOG.md')
-    end
   end
 end
 
@@ -73,6 +15,3 @@ end
 Fastlane::Changelog.all_classes.each do |current|
   require current
 end
-
-# By default we want to ensure CHANGELOG.md is present
-Fastlane::Changelog.setup_changelog

data/lib/fastlane/plugin/changelog/actions/read_changelog.rb

@@ -8,7 +8,7 @@ module Fastlane
     class ReadChangelogAction < Action
       def self.run(params)
         changelog_path = params[:changelog_path] unless params[:changelog_path].to_s.empty?
-        UI.error("CHANGELOG.md at path '#{changelog_path}' does not exist") unless File.exist?(changelog_path)
+        changelog_path = Helper::ChangelogHelper.ensure_changelog_exists(changelog_path)
 
         section_identifier = params[:section_identifier] unless params[:section_identifier].to_s.empty?
         escaped_section_identifier = Regexp.escape(section_identifier[/\[(.*?)\]/, 1])
@@ -77,7 +77,7 @@ module Fastlane
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :changelog_path,
-                                       env_name: "FL_READ_CHANGELOG_PATH_TO_CHANGELOG",
+                                       env_name: "FL_CHANGELOG_PATH",
                                        description: "The path to your project CHANGELOG.md",
                                        is_string: true,
                                        default_value: "./CHANGELOG.md",

data/lib/fastlane/plugin/changelog/actions/stamp_changelog.rb

@@ -6,7 +6,7 @@ module Fastlane
       def self.run(params)
         # 1. Ensure CHANGELOG.md exists
         changelog_path = params[:changelog_path] unless params[:changelog_path].to_s.empty?
-        UI.error("CHANGELOG.md at path '#{changelog_path}' does not exist") unless File.exist?(changelog_path)
+        changelog_path = Helper::ChangelogHelper.ensure_changelog_exists(changelog_path)
 
         # 2. Ensure there are changes in [Unreleased] section
         unreleased_section_content = Actions::ReadChangelogAction.run(changelog_path: changelog_path, section_identifier: UNRELEASED_IDENTIFIER, excluded_markdown_elements: ["###"])
@@ -108,7 +108,7 @@ module Fastlane
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :changelog_path,
-                                       env_name: "FL_STAMP_CHANGELOG_PATH_TO_CHANGELOG",
+                                       env_name: "FL_CHANGELOG_PATH",
                                        description: "The path to your project CHANGELOG.md",
                                        is_string: true,
                                        default_value: "./CHANGELOG.md",

data/lib/fastlane/plugin/changelog/actions/update_changelog.rb

@@ -3,7 +3,7 @@ module Fastlane
     class UpdateChangelogAction < Action
       def self.run(params)
         changelog_path = params[:changelog_path] unless params[:changelog_path].to_s.empty?
-        UI.error("CHANGELOG.md at path '#{changelog_path}' does not exist") unless File.exist?(changelog_path)
+        changelog_path = Helper::ChangelogHelper.ensure_changelog_exists(changelog_path)
 
         section_identifier = params[:section_identifier] unless params[:section_identifier].to_s.empty?
         escaped_section_identifier = section_identifier[/\[(.*?)\]/, 1]
@@ -95,7 +95,7 @@ module Fastlane
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :changelog_path,
-                                       env_name: "FL_UPDATE_CHANGELOG_PATH_TO_CHANGELOG",
+                                       env_name: "FL_CHANGELOG_PATH",
                                        description: "The path to your project CHANGELOG.md",
                                        is_string: true,
                                        default_value: "./CHANGELOG.md",

data/lib/fastlane/plugin/changelog/helper/changelog_helper.rb

@@ -1,13 +1,74 @@
 module Fastlane
   module Helper
+    CHANGELOG_PATH = './CHANGELOG.md'
+    DEFAULT_CHANGELOG = '# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+### Added
+- Your awesome new feature'
+
+    # TODO: ❗️ Add unit tests for methods in this class
     class ChangelogHelper
-      # class methods that you define here become available in your action
-      # as `Helper::ChangelogHelper.your_method`
-      #
-      def self.show_message
-        UI.message("Hello from the changelog plugin helper!")
+
+      # Ensures CHANGELOG.md exists at given path. If not, offers to create a default one. 
+      # Returns path to CHANGELOG.md to be used
+      def self.ensure_changelog_exists(path)
+        if File.exist?(path)
+          FastlaneCore::UI.success "Found CHANGELOG.md at #{path}"
+          path
+        else
+          FastlaneCore::UI.message("Cannot find CHANGELOG.md at #{path}")
+          generate_changelog
+          CHANGELOG_PATH
+        end
+      end
+
+      # Generates CHANGELOG.md in project root
+      def self.generate_changelog
+        if FastlaneCore::UI.confirm('Do you want to generate default CHANGELOG.md in the project root?')
+            FileUtils.touch 'CHANGELOG.md'
+            generate_comparison_link
+        else 
+            FastlaneCore::UI.error("Cannot continue without CHANGELOG.md file")
+        end
       end
 
+      # Generates link for tag comparison
+      def self.generate_comparison_link     
+        FastlaneCore::UI.message('Changelog plugin can automaticaly create a link for comparison between two tags (see https://github.com/pajapro/fastlane-plugin-changelog#--stamp_changelog)')
+        if FastlaneCore::UI.confirm('Do you want to create links for comparing tags?')
+          repo_url = FastlaneCore::UI.input('Enter your GitHub or Bitbucket repository URL (e.g.: https://github.com/owner/project or https://bitbucket.org/owner/project):')
+          compose_comparison_link(repo_url)
+        else
+          write_to_changelog(DEFAULT_CHANGELOG)
+        end
+      end
+
+      # Composes link for tag comparison for GitHub or Bitbucket
+      def self.compose_comparison_link(repo_url)
+        if repo_url.start_with?('https://github.com')
+          output = DEFAULT_CHANGELOG + "\n\n[Unreleased]: #{repo_url}/compare/master...HEAD"
+          write_to_changelog(output)
+        elsif repo_url.start_with?('https://bitbucket.org')
+          output = DEFAULT_CHANGELOG + "\n\n[Unreleased]: #{repo_url}/compare/master..HEAD"
+          write_to_changelog(output)
+        else
+          FastlaneCore::UI.error('Unknown repository host')
+          FastlaneCore::UI.message('Creating CHANGELOG.md without links for comparing tags')
+          write_to_changelog(DEFAULT_CHANGELOG)
+        end
+      end
+
+      # Writes given content to CHANGELOG.md in project root
+      def self.write_to_changelog(changelog)
+        File.open(CHANGELOG_PATH, 'w') { |f| f.write(changelog) }
+        FastlaneCore::UI.success('Successfuly created CHANGELOG.md')
+      end
+      
       def self.get_line_separator(file_path)
         f = File.open(file_path)
         enum = f.each_char

data/lib/fastlane/plugin/changelog/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Changelog
-    VERSION = "0.9.0"
+    VERSION = "0.10.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-changelog
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Pavel Prochazka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-25 00:00:00.000000000 Z
+date: 2018-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.96.0
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.96.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement