github_changelog_generator 1.15.0 → 1.16.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ee18824228b1ec5cade4842046046452afa0c4a0cab01ee3c52f86b60206cfb
-  data.tar.gz: 2c6df785e4d34d416255d1949e58a3a2668453e1a8246ae706989ddf17442bd7
+  metadata.gz: 8c1d6d65e8dbae7462cb4af0ef5dcef7ccd69fa0d77cb4d36b2e1e340f955e0e
+  data.tar.gz: 44f3e31077975a41154b8843253eb2dd56a1f37e6b8536fde56e825496568b7b
 SHA512:
-  metadata.gz: cd20b1b8916d83db50428dbe899c346d1a2b2ca1b26427fdc9997b2edf7604db530b9372c4461f443f4e7f0fc0133c6bd01b8643b1ec066cd1c80c4d0657ca3e
-  data.tar.gz: 41169d141f512dbecc520251f50fb9db63d4df6160621c5b8598dabf31095d9b75ae7b3aeab1bc126ac9fc5e5a71131026235bce4acb8661ed29744e6a246fa0
+  metadata.gz: 9dfcc5e4330a6bf05c098e0d5187259cb0993d7eb3d7c680a0bd12d70fa0ee5f00a2a334866460f5d011b19f6e4086109b8670590b8223885297fb0711beb102
+  data.tar.gz: c77fd119b4bd3d854f9873bd726076460253eecc66bfc20d35f127053f5a8c448568c4bdec9b69f0e80992b7b2eb9032483dc4ccf8b4e428fad3bb1aaadcaa69

data/README.md

@@ -5,11 +5,6 @@
 
 # github-changelog-generator ![GitHub Logo](../master/images/logo.jpg)
 
-#### Update:
-
-🖖 Keep it alive: We need more Collaborators to github-changelog-generator [#727](https://github.com/github-changelog-generator/github-changelog-generator/issues/727)
-
----
 <!--
 To update TOC, please run:
 > doctoc ./README.md --github
@@ -44,7 +39,7 @@ To update TOC, please run:
 
 ### Changelog generation has never been so easy
 
-**Fully automated changelog generation** - This gem generates a changelog file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub Issue Tracker.
+**Fully automated changelog generation** - This gem generates a changelog file based on **tags**, **issues** and merged **pull requests** (and splits them into separate lists according to labels) from :octocat: GitHub.
 
 Since you don't have to fill your `CHANGELOG.md` manually now: just run the script, relax and take a cup of :coffee: before your next release! :tada:
 
@@ -72,15 +67,35 @@ Install the gem like:
 Depending on your system, you _may_ need to run the shell as an Administrator (Windows),
 or use `sudo gem install github_changelog_generator` (Linux).
 
-## Running with Docker
 
-Using [Docker](https://www.docker.com/products/docker-desktop) is an alternative to installing Ruby and the gem.
+## Usage
+
+
+### Running with CLI:
 
-`ferrarimarco` has made a Docker image available that you can use.
+	   github_changelog_generator -u github_project_namespace -p github_project
+
+(where the project namespace is _likely_ your username if it's a project you own, but it could also be the namespace of the project)
+
+
+### Running with Docker
+
+Using [Docker](https://www.docker.com/products/docker-desktop) is an alternative to installing Ruby and the gem.
 
 Example invocation:
 
-    $ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator
+    $ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator
+
+
+
+- For GitHub Enterprise repos, specify *both* `--github-site` and `--github-api` options:
+
+       $ github_changelog_generator --github-site="https://github.yoursite.com" \
+                                  --github-api="https://github.yoursite.com/api/v3/"
+
+
+This generates a `CHANGELOG.md`, with pretty Markdown formatting.
+
 
 ## Output example
 
@@ -109,25 +124,6 @@ Example invocation:
 >
 > - support enterprise github via command line options [\#42](https://github.com/github-changelog-generator/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
 
-
-## Usage
-
--  Run this:
-
-	   $ github_changelog_generator -u github_username -p github_project
-
-	or, on the 1.14.x (current stable release)
-
-	   $ github_changelog_generator github_username/github_project
-
-
-- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
-
-       $ github_changelog_generator --github-site="https://github.yoursite.com" \
-                                  --github-api="https://github.yoursite.com/api/v3/"
-
-This generates a `CHANGELOG.md`, with pretty Markdown formatting.
-
 ### Params
 
 Print help for all command-line options to learn more details:
@@ -150,7 +146,7 @@ since-tag=1.0.0
 
 ### GitHub token
 
-GitHub only allows 50 unauthenticated requests per hour.
+GitHub only allows **50 unauthenticated requests per hour**.
 
 Therefore, it's recommended to run this script with authentication by using a **token**.
 
@@ -161,7 +157,7 @@ Here's how:
     - Run the script with `--token <your-40-digit-token>`; **OR**
     - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
 
-You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`):
+You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `.env`, `~/.bash_profile`, `~/.zshrc`, etc):
 
     export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
 
@@ -290,27 +286,6 @@ I'm not trying to compare the quality of handwritten and auto-generated logs. Th
 
 An auto-generated changelog really helps, even if you manually fill in the release notes!
 
-For example:
-
-When you find a closed bug, it is very useful to know which release fixed it.
-So that you can easily find the issue by \# in `CHANGELOG.md`.
-
-- It's not quite as easy to find this in handwritten releases notes.
-- A generated file saves you the trouble of remembering everything;
-  sometimes people forget to add things to a handwritten file.
-
-Ultimately, I think GitHub Releases are ideal for end-users.
-Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
-Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
-
-- ***I got an "API rate limit exceeded" error message. What does this mean?***
-
-GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
-
-If you're seeing this warning, please do the following:
-
-1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000.
-2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
 
 - ***My Ruby version is very old, can I use this?***
 
@@ -345,10 +320,13 @@ Workaround: Create a `C:\tmp`.
 
 ## Contributing
 
-We have collected notes on how to contribute to this project in [CONTRIBUTING.md].
+Would you like to contribute to this project? [CONTRIBUTING.md] has all the details on how to do that.
 
 [CONTRIBUTING.md]: CONTRIBUTING.md
 
+## Contact us
+[Join the chat at gitter : github-changelog-generator](https://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 ## License
 
-Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+GitHub Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -13,7 +13,7 @@ RSpec::Core::RakeTask.new
 
 desc "When releasing the gem, re-fetch latest cacert.pem from curl.haxx.se. Developer task."
 task :update_ssl_ca_file do
-  `pushd lib/github_changelog_generator/ssl_certs && curl --remote-name --time-cond cacert.pem https://curl.haxx.se/ca/cacert.pem && popd`
+  `pushd lib/github_changelog_generator/ssl_certs && curl --remote-name --time-cond cacert.pem https://curl.se/ca/cacert.pem && popd`
 end
 
 task default: %i[rubocop spec]

data/lib/github_changelog_generator/argv_parser.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "github_changelog_generator/version"
+
+module GitHubChangelogGenerator
+  class ArgvParser
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def parse!(argv)
+      parser.parse(argv)
+    rescue OptionParser::ParseError => e
+      warn [e, parser].join("\n")
+      Kernel.abort
+    end
+
+    def parser
+      @parser ||= OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
+        opts.banner = "Usage: github_changelog_generator --user USER --project PROJECT [options]"
+        opts.on("-u", "--user USER", "Username of the owner of the target GitHub repo OR the namespace of target Github repo if owned by an organization.") do |last|
+          options[:user] = last
+        end
+        opts.on("-p", "--project PROJECT", "Name of project on GitHub.") do |last|
+          options[:project] = last
+        end
+        opts.on("-t", "--token TOKEN", "To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new") do |last|
+          options[:token] = last
+        end
+        opts.on("-f", "--date-format FORMAT", "Date format. Default is %Y-%m-%d.") do |last|
+          options[:date_format] = last
+        end
+        opts.on("-o", "--output NAME", "Output file. To print to STDOUT instead, use blank as path. Default is CHANGELOG.md") do |last|
+          options[:output] = last
+        end
+        opts.on("-b", "--base NAME", "Optional base file to append generated changes to. Default is HISTORY.md") do |last|
+          options[:base] = last
+        end
+        opts.on("--summary-label LABEL", "Set up custom label for the release summary section. Default is \"\".") do |v|
+          options[:summary_prefix] = v
+        end
+        opts.on("--breaking-label LABEL", "Set up custom label for the breaking changes section. Default is \"**Breaking changes:**\".") do |v|
+          options[:breaking_prefix] = v
+        end
+        opts.on("--enhancement-label LABEL", "Set up custom label for enhancements section. Default is \"**Implemented enhancements:**\".") do |v|
+          options[:enhancement_prefix] = v
+        end
+        opts.on("--bugs-label LABEL", "Set up custom label for bug-fixes section. Default is \"**Fixed bugs:**\".") do |v|
+          options[:bug_prefix] = v
+        end
+        opts.on("--deprecated-label LABEL", "Set up custom label for the deprecated changes section. Default is \"**Deprecated:**\".") do |v|
+          options[:deprecated_prefix] = v
+        end
+        opts.on("--removed-label LABEL", "Set up custom label for the removed changes section. Default is \"**Removed:**\".") do |v|
+          options[:removed_prefix] = v
+        end
+        opts.on("--security-label LABEL", "Set up custom label for the security changes section. Default is \"**Security fixes:**\".") do |v|
+          options[:security_prefix] = v
+        end
+        opts.on("--issues-label LABEL", "Set up custom label for closed-issues section. Default is \"**Closed issues:**\".") do |v|
+          options[:issue_prefix] = v
+        end
+        opts.on("--header-label LABEL", "Set up custom header label. Default is \"# Changelog\".") do |v|
+          options[:header] = v
+        end
+        opts.on("--configure-sections HASH, STRING", "Define your own set of sections which overrides all default sections.") do |v|
+          options[:configure_sections] = v
+        end
+        opts.on("--add-sections HASH, STRING", "Add new sections but keep the default sections.") do |v|
+          options[:add_sections] = v
+        end
+        opts.on("--front-matter JSON", "Add YAML front matter. Formatted as JSON because it's easier to add on the command line.") do |v|
+          require "yaml"
+          options[:frontmatter] = "#{JSON.parse(v).to_yaml}---\n"
+        end
+        opts.on("--pr-label LABEL", "Set up custom label for pull requests section. Default is \"**Merged pull requests:**\".") do |v|
+          options[:merge_prefix] = v
+        end
+        opts.on("--[no-]issues", "Include closed issues in changelog. Default is true.") do |v|
+          options[:issues] = v
+        end
+        opts.on("--[no-]issues-wo-labels", "Include closed issues without labels in changelog. Default is true.") do |v|
+          options[:add_issues_wo_labels] = v
+        end
+        opts.on("--[no-]pr-wo-labels", "Include pull requests without labels in changelog. Default is true.") do |v|
+          options[:add_pr_wo_labels] = v
+        end
+        opts.on("--[no-]pull-requests", "Include pull-requests in changelog. Default is true.") do |v|
+          options[:pulls] = v
+        end
+        opts.on("--[no-]filter-by-milestone", "Use milestone to detect when issue was resolved. Default is true.") do |last|
+          options[:filter_issues_by_milestone] = last
+        end
+        opts.on("--[no-]issues-of-open-milestones", "Include issues of open milestones. Default is true.") do |v|
+          options[:issues_of_open_milestones] = v
+        end
+        opts.on("--[no-]author", "Add author of pull request at the end. Default is true.") do |author|
+          options[:author] = author
+        end
+        opts.on("--usernames-as-github-logins", "Use GitHub tags instead of Markdown links for the author of an issue or pull-request.") do |v|
+          options[:usernames_as_github_logins] = v
+        end
+        opts.on("--unreleased-only", "Generate log from unreleased closed issues only.") do |v|
+          options[:unreleased_only] = v
+        end
+        opts.on("--[no-]unreleased", "Add to log unreleased closed issues. Default is true.") do |v|
+          options[:unreleased] = v
+        end
+        opts.on("--unreleased-label LABEL", "Set up custom label for unreleased closed issues section. Default is \"**Unreleased:**\".") do |v|
+          options[:unreleased_label] = v
+        end
+        opts.on("--[no-]compare-link", "Include compare link (Full Changelog) between older version and newer version. Default is true.") do |v|
+          options[:compare_link] = v
+        end
+        opts.on("--include-labels  x,y,z", Array, "Of the labeled issues, only include the ones with the specified labels.") do |list|
+          options[:include_labels] = list
+        end
+        opts.on("--exclude-labels  x,y,z", Array, "Issues with the specified labels will be excluded from changelog. Default is 'duplicate,question,invalid,wontfix'.") do |list|
+          options[:exclude_labels] = list
+        end
+        opts.on("--summary-labels x,y,z", Array, 'Issues with these labels will be added to a new section, called "Release Summary". The section display only body of issues. Default is \'release-summary,summary\'.') do |list|
+          options[:summary_labels] = list
+        end
+        opts.on("--breaking-labels x,y,z", Array, 'Issues with these labels will be added to a new section, called "Breaking changes". Default is \'backwards-incompatible,breaking\'.') do |list|
+          options[:breaking_labels] = list
+        end
+        opts.on("--enhancement-labels  x,y,z", Array, 'Issues with the specified labels will be added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'.') do |list|
+          options[:enhancement_labels] = list
+        end
+        opts.on("--bug-labels  x,y,z", Array, 'Issues with the specified labels will be added to "Fixed bugs" section. Default is \'bug,Bug\'.') do |list|
+          options[:bug_labels] = list
+        end
+        opts.on("--deprecated-labels x,y,z", Array, 'Issues with the specified labels will be added to a section called "Deprecated". Default is \'deprecated,Deprecated\'.') do |list|
+          options[:deprecated_labels] = list
+        end
+        opts.on("--removed-labels x,y,z", Array, 'Issues with the specified labels will be added to a section called "Removed". Default is \'removed,Removed\'.') do |list|
+          options[:removed_labels] = list
+        end
+        opts.on("--security-labels x,y,z", Array, 'Issues with the specified labels will be added to a section called "Security fixes". Default is \'security,Security\'.') do |list|
+          options[:security_labels] = list
+        end
+        opts.on("--issue-line-labels x,y,z", Array, 'The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].') do |list|
+          options[:issue_line_labels] = list
+        end
+        opts.on("--include-tags-regex REGEX", "Apply a regular expression on tag names so that they can be included, for example: --include-tags-regex \".*\+\d{1,}\".") do |last|
+          options[:include_tags_regex] = last
+        end
+        opts.on("--exclude-tags  x,y,z", Array, "Changelog will exclude specified tags") do |list|
+          options[:exclude_tags] = list
+        end
+        opts.on("--exclude-tags-regex REGEX", "Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex \".*\+\d{1,}\".") do |last|
+          options[:exclude_tags_regex] = last
+        end
+        opts.on("--since-tag  x", "Changelog will start after specified tag.") do |v|
+          options[:since_tag] = v
+        end
+        opts.on("--due-tag  x", "Changelog will end before specified tag.") do |v|
+          options[:due_tag] = v
+        end
+        opts.on("--since-commit  x", "Fetch only commits after this time. eg. \"2017-01-01 10:00:00\"") do |v|
+          options[:since_commit] = v
+        end
+        opts.on("--max-issues NUMBER", Integer, "Maximum number of issues to fetch from GitHub. Default is unlimited.") do |max|
+          options[:max_issues] = max
+        end
+        opts.on("--release-url URL", "The URL to point to for release links, in printf format (with the tag as variable).") do |url|
+          options[:release_url] = url
+        end
+        opts.on("--github-site URL", "The Enterprise GitHub site where your project is hosted.") do |last|
+          options[:github_site] = last
+        end
+        opts.on("--github-api URL", "The enterprise endpoint to use for your GitHub API.") do |last|
+          options[:github_endpoint] = last
+        end
+        opts.on("--simple-list", "Create a simple list from issues and pull requests. Default is false.") do |v|
+          options[:simple_list] = v
+        end
+        opts.on("--future-release RELEASE-VERSION", "Put the unreleased changes in the specified release number.") do |future_release|
+          options[:future_release] = future_release
+        end
+        opts.on("--release-branch RELEASE-BRANCH", "Limit pull requests to the release branch, such as master or release.") do |release_branch|
+          options[:release_branch] = release_branch
+        end
+        opts.on("--[no-]http-cache", "Use HTTP Cache to cache GitHub API requests (useful for large repos). Default is true.") do |http_cache|
+          options[:http_cache] = http_cache
+        end
+        opts.on("--cache-file CACHE-FILE", "Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.") do |cache_file|
+          options[:cache_file] = cache_file
+        end
+        opts.on("--cache-log CACHE-LOG", "Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.") do |cache_log|
+          options[:cache_log] = cache_log
+        end
+        opts.on("--config-file CONFIG-FILE", "Path to configuration file. Default is .github_changelog_generator.") do |config_file|
+          options[:config_file] = config_file
+        end
+        opts.on("--ssl-ca-file PATH", "Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.") do |ssl_ca_file|
+          options[:ssl_ca_file] = ssl_ca_file
+        end
+        opts.on("--require x,y,z", Array, "Path to Ruby file(s) to require before generating changelog.") do |paths|
+          options[:require] = paths
+        end
+        opts.on("--[no-]verbose", "Run verbosely. Default is true.") do |v|
+          options[:verbose] = v
+        end
+        opts.on("-v", "--version", "Print version number.") do |_v|
+          puts "Version: #{GitHubChangelogGenerator::VERSION}"
+          exit
+        end
+        opts.on("-h", "--help", "Displays Help.") do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    class << self
+      def banner
+        new.parser.banner
+      end
+    end
+  end
+end

data/lib/github_changelog_generator/generator/entry.rb

@@ -40,6 +40,15 @@ module GitHubChangelogGenerator
       @content
     end
 
+    def line_labels_for(issue)
+      labels = if @options[:issue_line_labels] == ["ALL"]
+                 issue["labels"]
+               else
+                 issue["labels"].select { |label| @options[:issue_line_labels].include?(label["name"]) }
+               end
+      labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
+    end
+
     private
 
     # Creates section objects for this entry.
@@ -72,7 +81,7 @@ module GitHubChangelogGenerator
       end
 
       sections_json.collect do |name, v|
-        Section.new(name: name.to_s, prefix: v["prefix"], labels: v["labels"], options: @options)
+        Section.new(name: name.to_s, prefix: v["prefix"], labels: v["labels"], body_only: v["body_only"], options: @options)
       end
     end
 
@@ -205,14 +214,5 @@ module GitHubChangelogGenerator
       end
       nil
     end
-
-    def line_labels_for(issue)
-      labels = if @options[:issue_line_labels] == ["ALL"]
-                 issue["labels"]
-               else
-                 issue["labels"].select { |label| @options[:issue_line_labels].include?(label["name"]) }
-               end
-      labels.map { |label| " \[[#{label['name']}](#{label['url'].sub('api.github.com/repos', 'github.com')})\]" }.join("")
-    end
   end
 end

data/lib/github_changelog_generator/generator/generator.rb

@@ -26,6 +26,12 @@ module GitHubChangelogGenerator
   class Generator
     attr_accessor :options, :filtered_tags, :tag_section_mapping, :sorted_tags
 
+    CREDIT_LINE = <<~CREDIT
+      \\* *This Changelog was automatically generated \
+      by [github_changelog_generator]\
+      (https://github.com/github-changelog-generator/github-changelog-generator)*
+    CREDIT
+
     # A Generator responsible for all logic, related with changelog generation from ready-to-parse issues
     #
     # Example:
@@ -43,26 +49,21 @@ module GitHubChangelogGenerator
     # @return [String] Generated changelog file
     def compound_changelog
       @options.load_custom_ruby_files
-      fetch_and_filter_tags
-      fetch_issues_and_pr
-
-      log = ""
-      log += @options[:frontmatter] if @options[:frontmatter]
-      log += "#{options[:header]}\n\n"
-
-      log += if @options[:unreleased_only]
-               generate_entry_between_tags(@filtered_tags[0], nil)
-             else
-               generate_entries_for_all_tags
-             end
-
-      log += File.read(@options[:base]) if File.file?(@options[:base])
-
-      credit_line = "\n\n\\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*"
-      log.gsub!(/#{credit_line}(\n)?/, "") # Remove old credit lines
-      log += "#{credit_line}\n"
 
-      @log = log
+      Sync do
+        fetch_and_filter_tags
+        fetch_issues_and_pr
+
+        log = if @options[:unreleased_only]
+                generate_entry_between_tags(@filtered_tags[0], nil)
+              else
+                generate_entries_for_all_tags
+              end
+        log += File.read(@options[:base]) if File.file?(@options[:base])
+        log = remove_old_fixed_string(log)
+        log = insert_fixed_string(log)
+        @log = log
+      end
     end
 
     private
@@ -151,5 +152,26 @@ module GitHubChangelogGenerator
       add_first_occurring_tag_to_prs(@sorted_tags, @pull_requests)
       nil
     end
+
+    # Remove the previously assigned fixed message.
+    # @param log [String] Old lines are fixed
+    def remove_old_fixed_string(log)
+      log.gsub!(/#{Regexp.escape(@options[:frontmatter])}/, "") if @options[:frontmatter]
+      log.gsub!(/#{Regexp.escape(@options[:header])}\n{,2}/, "")
+      log.gsub!(/\n{,2}#{Regexp.escape(CREDIT_LINE)}/, "") # Remove old credit lines
+      log
+    end
+
+    # Add template messages to given string. Previously added
+    # messages of the same wording are removed.
+    # @param log [String]
+    def insert_fixed_string(log)
+      ins = ""
+      ins += @options[:frontmatter] if @options[:frontmatter]
+      ins += "#{@options[:header]}\n\n"
+      log.insert(0, ins)
+      log += "\n\n#{CREDIT_LINE}"
+      log
+    end
   end
 end