abstract_feature_branch 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39c4f8aecce089f175cc513abd3aafad9496eed3
-  data.tar.gz: eee7c48b9f9a6e8f10e834f472cc46257399a155
+  metadata.gz: 695366cdc70dc9883e9bcfcc498c384d8b52620c
+  data.tar.gz: 9850c42b60dd40e604500acac757ea21598dd339
 SHA512:
-  metadata.gz: 55903d3949b2f5c619d8d11ef45f829df1e1f9fdfcde2f714db9fe807eef138a9d9f758e345f9a8cd5941d2be6901a6cea57ed4b3aa1d712c14d61a7a2d7ea0d
-  data.tar.gz: 5a85cb2406e37bb19f9adb933d6180123abfef0c48f2f0ca2ca7f2a9cbce36de2e0584d8123f883b841b44632111e3f3a1dbf35857704a2e1d6c5f95536df6bb
+  metadata.gz: 918fdebd4a2ea0b5f600141910d816573721434bb3931dd7d0e881815adfec0f5c0da2c084e1e5cd1a667c812a9ca95457929ef16b1afa477202c40c7db5861b
+  data.tar.gz: a1a7c5fceca419639dee473ee41d38ef9b0d9bb7f1aff55242d7fa4147e71ee950c860a8dac8172ce1c3a1e11b3c0c46f85894a4f36a9030410dae18368320af

data/README.md

@@ -7,10 +7,10 @@ abstract_feature_branch is a Rails gem that enables developers to easily branch
 http://paulhammant.com/blog/branch_by_abstraction.html
 
 It is a productivity and fault tolerance enhancing team practice that has been utilized by professional software development
-teams at large corporations, such as Sears and Groupon.
+teams at large corporations, such as [Sears](http://www.sears.com) and [Groupon](http://www.groupon.com).
 
-It gives ability to wrap blocks of code with an abstract feature branch name, and then
-specify which features to be switched on or off in a configuration file.
+It provides the ability to wrap blocks of code with an abstract feature branch name, and then
+specify in a configuration file which features to be switched on or off.
 
 The goal is to build out upcoming features in the same source code repository branch, regardless of whether all are
 completed by the next release date or not, thus increasing team productivity by preventing integration delays.
@@ -21,7 +21,7 @@ This gives developers the added benefit of being able to switch a feature off af
 for a high risk feature.
 
 abstract_feature_branch additionally supports [DDD](http://www.domaindrivendesign.org)'s pattern of
-[bounded contexts](http://dddcommunity.org/uncategorized/bounded-context/) by allowing developers to configure
+[Bounded Contexts](http://dddcommunity.org/uncategorized/bounded-context/) by allowing developers to configure
 context-specific feature files if needed.
 
 Requirements
@@ -32,25 +32,26 @@ Requirements
 Setup
 -----
 
-### Rails Application
+### Rails Application Use
 
 1. Configure Rubygem
-   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.7.1'</pre>
-   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '0.7.1'</pre>
-2. Generate <code>config/initializers/abstract_feature_branch.rb</code>, <code>config/features.yml</code> and <code>config/features.local.yml</code> in your Rails app directory by running <pre>rails g abstract_feature_branch:install</pre>
-3. (Optional) Generate <code>config/features/[context_path].yml</code> in your Rails app directory by running <pre>rails g abstract_feature_branch:context context_path</pre> (more details under **instructions**)
+   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.8.0'</pre>
+   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '0.8.0'</pre>
+2. Generate <code>config/initializers/abstract_feature_branch.rb</code>, <code>lib/tasks/abstract_feature_branch.rake</code>, <code>config/features.yml</code> and <code>config/features.local.yml</code> in your Rails app directory by running <pre>rails g abstract_feature_branch:install</pre>
+3. (Optional) Generate <code>config/features/[context_path].yml</code> in your Rails app directory by running <pre>rails g abstract_feature_branch:context context_path</pre> (more details under [**instructions**](#instructions))
 4. (Optional and rarely needed) Customize configuration in <code>config/initializers/abstract_feature_branch.rb</code> (can be useful for changing location of feature files in Rails application or troubleshooting a specific Rails environment feature configuration)
 
-### Ruby Application (general use)
+### Ruby Application General Use
 
-1. <pre>gem install abstract_feature_branch -v 0.7.1</pre>
+1. <pre>gem install abstract_feature_branch -v 0.8.0</pre>
 2. Add code <code>require 'abstract_feature_branch'</code>
-3. Create <code>config/features.yml</code> under <code>AbstractFeatureBranch.application_root</code> and fill it with content similar to that of the sample <code>config/features.yml</code> mentioned under **instructions**.
-4. (Optional) Create <code>config/features.local.yml</code> under <code>AbstractFeatureBranch.application_root</code>  (more details under **instructions**)
-5. (Optional) Create <code>config/features/[context_path].yml</code> under <code>AbstractFeatureBranch.application_root</code> (more details under **instructions**)
+3. Create <code>config/features.yml</code> under <code>AbstractFeatureBranch.application_root</code> and fill it with content similar to that of the sample <code>config/features.yml</code> mentioned under [**instructions**](#instructions).
+4. (Optional) Create <code>config/features.local.yml</code> under <code>AbstractFeatureBranch.application_root</code>  (more details under [**instructions**](#instructions))
+5. (Optional) Create <code>config/features/[context_path].yml</code> under <code>AbstractFeatureBranch.application_root</code> (more details under [**instructions**](#instructions))
 6. (Optional) Add code <code>AbstractFeatureBranch.application_root = "[your_application_path]"</code> to configure the location of feature files (it defaults to <code>'.'</code>)
 7. (Optional) Add code <code>AbstractFeatureBranch.application_environment = "[your_application_environment]"</code> (it defaults to <code>'development'</code>). Alternatively, you can set <code>ENV['APP_ENV']</code> before the <code>require</code> statement or an an external environment variable.
-8. (Optional) Add code <code>AbstractFeatureBranch.load_application_features</code> to pre-load application features for improved first-use performance
+8. (Optional) Add code <code>AbstractFeatureBranch.logger = "[your_application_logger]"</code> (it defaults to a new instance of Ruby <code>Logger</code>. Must use a logger with <code>info</code> and <code>warn</code> methods).
+9. (Optional) Add code <code>AbstractFeatureBranch.load_application_features</code> to pre-load application features for improved first-use performance
 
 Instructions
 ------------
@@ -128,20 +129,6 @@ Note that <code>feature_branch</code> executes the false branch if the feature i
 
 Note that <code>feature_enabled?</code> returns false if the feature is disabled and nil if the feature is non-existent (practically the same effect, but nil can sometimes be useful to detect if a feature is referenced).
 
-Initializer
------------
-
-Here is the content of the generated initializer (<code>config/initializers/abstract_feature_branch.rb</code>), which contains instructions on how to customize:
-
->     # Application root where config/features.yml or config/features/ is found
->     AbstractFeatureBranch.application_root = Rails.root
->
->     # Application environment (e.g. "development", "staging" or "production")
->     AbstractFeatureBranch.application_environment = Rails.env.to_s
->
->     # Pre-loads application features to improve performance of first web-page hit
->     AbstractFeatureBranch.load_application_features
-
 Recommendations
 ---------------
 
@@ -199,11 +186,11 @@ simply switching off the URL route to them. Example:
 >     }
 
 - Once a feature has been released and switched on in production, and it has worked well for a while (e.g. for two consecutive releases),
-it is recommended that its feature branching code is plucked out of the codebase to simplify and improve
+it is **strongly recommended** that its feature branching code is plucked out of the codebase to simplify and improve
 future maintainability given that it is no longer needed at that point.
 
-- Split <code>config/features.yml</code> into multiple context-specific feature files once it grows too big (e.g. 20+ features) by
-utilizing the context generator mentioned above: <pre>rails g abstract_feature_branch:context context_path</pre>
+- Once <code>config/features.yml</code> grows too big (e.g. 20+ features), it is **strongly recommended* to split it into
+multiple context-specific feature files by utilizing the context generator mentioned above: <pre>rails g abstract_feature_branch:context context_path</pre>
 
 - When working on a new feature locally that the developer does not want others on the team to see yet, the feature
 can be enabled in <code>config/features.local.yml</code> only as it is git ignored, and disabled in <code>config/features.yml</code>
@@ -262,11 +249,12 @@ Gotcha with abstract feature branching in CSS and JS files:
 
 If you've used abstract feature branching in CSS or JS files via ERB, setting environment variable overrides won't
 affect them as you need asset recompilation in addition to it, which can only be triggered by changing a CSS or JS
-file and redeploying on Heroku (hint: even if it's just a minor change to force it). In any case, environment variable
+file and redeploying on Heroku (even if it's just a minor change to force it). In any case, environment variable
 overrides have been recommended above as an emergency or temporary measure. If there is a need to rely on environment
-variable overrides to alter the style or JavaScript behavior of a page back and forth without a redeploy, one solution
-is to do additional abstract feature branching in HTML templates (e.g. ERB or HAML templates) to link to different
-CSS classes or invoke different JavaScript methods per branch of HTML for example.
+variable overrides to alter the style or JavaScript behavior of a page back and forth without a redeploy, **one solution**
+is to do additional abstract feature branching in HTML templates (e.g. ERB or [HAML](http://haml.info) to
+link to different stylesheets and JS files, use different CSS classes, or invoke different JavaScript methods per branch
+of HTML for example.
 
 Feature Configuration Load Order
 --------------------------------
@@ -280,9 +268,119 @@ the former if overlap in features occurs:
 4. Main local feature file override: <code>config/features.local.yml</code>
 5. Environment variable overrides
 
+Rails Initializer
+-----------------
+
+Here is the content of the generated initializer (<code>config/initializers/abstract_feature_branch.rb</code>), which contains instructions on how to customize via [dependency injection](http://en.wikipedia.org/wiki/Dependency_injection):
+
+>     # Application root where config/features.yml or config/features/ is found
+>     AbstractFeatureBranch.application_root = Rails.root
+>
+>     # Application environment (e.g. "development", "staging" or "production")
+>     AbstractFeatureBranch.application_environment = Rails.env.to_s
+>
+>     # Abstract Feature Branch logger
+>     AbstractFeatureBranch.logger = Rails.logger
+>
+>     # Pre-loads application features to improve performance of first web-page hit
+>     AbstractFeatureBranch.load_application_features
+
+Rake Task
+---------
+
+Abstract Feature Branch comes with a rake task to beautify feature files that have grown unorganized by sorting features
+by name and getting rid of extra empty lines. It does so per section, without affecting the order of the sections
+themselves.
+
+For example, here is content before and after beautification.
+
+Before:
+
+>     defaults: &defaults
+>
+>
+>       gallery: true
+>
+>       carousel: true
+>
+>       third_party_integration: false
+>       caching: true
+>
+>     development:
+>       <<: *defaults
+>
+>     test:
+>       <<: *defaults
+>
+>       caching: false
+>
+>     staging:
+>       <<: *defaults
+>       third_party_integration: true
+>       caching: true
+>
+>     production:
+>       <<: *defaults
+>       third_party_integration: false
+>
+>       caching: false
+
+After:
+
+>     defaults: &defaults
+>       caching: true
+>       carousel: true
+>       gallery: true
+>       third_party_integration: false
+>
+>     development:
+>       <<: *defaults
+>
+>     test:
+>       <<: *defaults
+>       caching: false
+>
+>     staging:
+>       <<: *defaults
+>       caching: true
+>       third_party_integration: true
+>
+>     production:
+>       <<: *defaults
+>       caching: false
+>       third_party_integration: false
+
+This is very useful in bigger applications that have scores of features since it allows a developer to quickly scan
+for alphabetical sorted feature names. Although file find is an alternative solution, having tidy organized feature
+names can help increase overall team productivity in the long term.
+
+For Rails application use, the rake task is generated under <code>lib/tasks/abstract_feature_branch.rake</code>.
+
+For Ruby application general use, here is the content of the rake task:
+
+>     namespace :abstract_feature_branch do
+>
+>       desc "Beautify YAML of specified feature file via file_path argument or all feature files when no argument specified (config/features.yml, config/features.local.yml, and config/features/**/*.yml) by sorting features by name and eliminating extra empty lines"
+>       task :beautify_files, :file_path do |_, args|
+>         AbstractFeatureBranch::FileBeautifier.process(args[:file_path])
+>       end
+>
+>     end
+
+The rake task may be invoked in a number of ways:
+- <code>rake abstract_feature_branch:beautify_files</code> beautifies all feature files under [application_root]/config
+- <code>rake abstract_feature_branch:beautify_files[file_path]</code> beautifies a single feature file
+- <code>rake abstract_feature_branch:beautify_files[directory_path]</code> beautifies all feature files under directory path recursively
+
+Verify after the task has been invoked that your feature file contents are to your satisfaction before committing the
+task changes.
+
 Release Notes
 -------------
 
+Version 0.8.0:
+- Added rake task for beautifying feature files, sorting feature names within environment sections and eliminating extra empty lines. Added support for externalized logger.
+
 Version 0.7.1:
 - Fixed undefined method issue with using <code>AbstractFeatureBranch.load_application_features</code> to improve first use performance
 
@@ -330,7 +428,6 @@ Version 0.2.0:
 Upcoming
 --------
 
-- Add rake task to reorder feature entries in feature.yml alphabetically
 - Support runtime read of features yml in development for easy testing purposes (trading off performance)
 - Support configuring per environment whether features yml is read at runtime or not (given performance trade-off)
 
@@ -353,6 +450,10 @@ Contributors
 ---------------------------------------
 [Christian Nennemann](https://github.com/XORwell)
 
+Feedback and Idea Providers
+---------------------------------------
+[Ben Downey](https://github.com/bnd5k)
+
 Copyright
 ---------------------------------------
 

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.8.0

data/abstract_feature_branch.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch"
-  s.version = "0.7.1"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Annas \"Andy\" Maleh"]
   s.date = "2013-11-25"
-  s.description = "It gives ability to wrap blocks of code with an abstract feature branch name, and then\nspecify which features to be switched on or off in a configuration file.\n\nThe goal is to build out future features with full integration into the codebase, thus\nensuring no delay in integration in the future, while releasing currently done features\nat the same time. Developers then disable future features until they are ready to be\nswitched on in production, but do enable them in staging and locally.\n\nThis gives developers the added benefit of being able to switch a feature off after\nrelease should big problems arise for a high risk feature.\n"
+  s.description = "abstract_feature_branch is a Rails gem that enables developers to easily branch by abstraction as per this pattern:\nhttp://paulhammant.com/blog/branch_by_abstraction.html\n\nIt is a productivity and fault tolerance enhancing team practice that has been utilized by professional software development\nteams at large corporations, such as Sears and Groupon.\n\nIt provides the ability to wrap blocks of code with an abstract feature branch name, and then\nspecify in a configuration file which features to be switched on or off.\n\nThe goal is to build out upcoming features in the same source code repository branch, regardless of whether all are\ncompleted by the next release date or not, thus increasing team productivity by preventing integration delays.\nDevelopers then disable in-progress features until they are ready to be switched on in production, yet enable them\nlocally and in staging environments for in-progress testing.\n\nThis gives developers the added benefit of being able to switch a feature off after release should big problems arise\nfor a high risk feature.\n\nabstract_feature_branch additionally supports DDD's pattern of\nBounded Contexts by allowing developers to configure\ncontext-specific feature files if needed.\n"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
     "config/features/public.local.yml",
     "config/features/public.yml",
     "lib/abstract_feature_branch.rb",
+    "lib/abstract_feature_branch/file_beautifier.rb",
     "lib/ext/feature_branch.rb",
     "lib/generators/abstract_feature_branch/context_generator.rb",
     "lib/generators/abstract_feature_branch/install_generator.rb",
@@ -35,9 +36,26 @@ Gem::Specification.new do |s|
     "lib/generators/templates/config/features.local.yml",
     "lib/generators/templates/config/features.yml",
     "lib/generators/templates/config/initializers/abstract_feature_branch.rb",
-    "spec/application_no_config/no_config",
-    "spec/application_rails_config/config/features.local.yml",
-    "spec/application_rails_config/config/features.yml"
+    "lib/generators/templates/lib/tasks/abstract_feature_branch.rake",
+    "spec/abstract_feature_branch/file_beautifier_spec.rb",
+    "spec/ext/feature_branch__feature_branch_spec.rb",
+    "spec/ext/feature_branch__feature_enabled_spec.rb",
+    "spec/fixtures/application_no_config/no_config",
+    "spec/fixtures/application_rails_config/config/features.local.yml",
+    "spec/fixtures/application_rails_config/config/features.yml",
+    "spec/fixtures/application_ugly_config_reference/config/another_application_configuration.yml",
+    "spec/fixtures/application_ugly_config_reference/config/database.yml",
+    "spec/fixtures/application_ugly_config_reference/config/features.local.yml",
+    "spec/fixtures/application_ugly_config_reference/config/features.yml",
+    "spec/fixtures/application_ugly_config_reference/config/features/admin.local.yml",
+    "spec/fixtures/application_ugly_config_reference/config/features/admin.yml",
+    "spec/fixtures/application_ugly_config_reference/config/features/empty.local.yml",
+    "spec/fixtures/application_ugly_config_reference/config/features/feature_empty_config.local.yml",
+    "spec/fixtures/application_ugly_config_reference/config/features/including_comments.local.yml",
+    "spec/fixtures/application_ugly_config_reference/config/features/internal/wiki.local.yml",
+    "spec/fixtures/application_ugly_config_reference/config/features/internal/wiki.yml",
+    "spec/fixtures/application_ugly_config_reference/config/features/public.local.yml",
+    "spec/fixtures/application_ugly_config_reference/config/features/public.yml"
   ]
   s.homepage = "http://github.com/AndyObtiva/abstract_feature_branch"
   s.licenses = ["MIT"]
@@ -50,20 +68,17 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<deep_merge>, ["= 1.0.0"])
-      s.add_development_dependency(%q<rspec>, ["= 2.11.0"])
-      s.add_development_dependency(%q<rdoc>, ["= 3.12.2"])
       s.add_development_dependency(%q<jeweler>, ["= 1.8.8"])
+      s.add_development_dependency(%q<rspec>, ["= 2.14.1"])
     else
       s.add_dependency(%q<deep_merge>, ["= 1.0.0"])
-      s.add_dependency(%q<rspec>, ["= 2.11.0"])
-      s.add_dependency(%q<rdoc>, ["= 3.12.2"])
       s.add_dependency(%q<jeweler>, ["= 1.8.8"])
+      s.add_dependency(%q<rspec>, ["= 2.14.1"])
     end
   else
     s.add_dependency(%q<deep_merge>, ["= 1.0.0"])
-    s.add_dependency(%q<rspec>, ["= 2.11.0"])
-    s.add_dependency(%q<rdoc>, ["= 3.12.2"])
     s.add_dependency(%q<jeweler>, ["= 1.8.8"])
+    s.add_dependency(%q<rspec>, ["= 2.14.1"])
   end
 end
 

data/config/features/admin.local.yml

@@ -11,4 +11,5 @@ staging:
   <<: *defaults
 
 production:
-  <<: *defaults
+  <<: *defaults
+

data/config/features/admin.yml

@@ -13,4 +13,5 @@ staging:
   <<: *defaults
 
 production:
-  <<: *defaults
+  <<: *defaults
+

data/config/features/internal/wiki.local.yml

@@ -11,4 +11,5 @@ staging:
   <<: *defaults
 
 production:
-  <<: *defaults
+  <<: *defaults
+

data/config/features/internal/wiki.yml

@@ -13,4 +13,5 @@ staging:
   <<: *defaults
 
 production:
-  <<: *defaults
+  <<: *defaults
+

data/config/features/public.local.yml

@@ -11,4 +11,5 @@ staging:
   <<: *defaults
 
 production:
-  <<: *defaults
+  <<: *defaults
+

data/config/features/public.yml

@@ -13,4 +13,5 @@ staging:
   <<: *defaults
 
 production:
-  <<: *defaults
+  <<: *defaults
+

data/lib/abstract_feature_branch.rb

@@ -9,6 +9,7 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
+require 'logger' unless defined?(Rails) && Rails.logger
 require 'deep_merge' unless {}.respond_to?(:deep_merge!)
 
 module AbstractFeatureBranch
@@ -19,7 +20,7 @@ module AbstractFeatureBranch
     @application_root = path
   end
   def self.initialize_application_root
-    self.application_root = Object.const_defined?(:Rails) ? Rails.root : '.'
+    self.application_root = defined?(Rails) ? Rails.root : '.'
   end
   def self.application_environment
     @application_environment ||= initialize_application_environment
@@ -28,7 +29,16 @@ module AbstractFeatureBranch
     @application_environment = environment
   end
   def self.initialize_application_environment
-    self.application_environment = Object.const_defined?(:Rails) ? Rails.env.to_s : ENV['APP_ENV'] || 'development'
+    self.application_environment = defined?(Rails) ? Rails.env.to_s : ENV['APP_ENV'] || 'development'
+  end
+  def self.logger
+    @logger ||= initialize_logger
+  end
+  def self.logger=(logger)
+    @logger = logger
+  end
+  def self.initialize_logger
+    self.logger = defined?(Rails) && Rails.logger ? Rails.logger : Logger.new(STDOUT)
   end
   def self.environment_variable_overrides
     @environment_variable_overrides ||= load_environment_variable_overrides
@@ -102,8 +112,9 @@ module AbstractFeatureBranch
   end
 
   def self.downcase_feature_hash_keys(hash)
-    Hash[hash.map {|k, v| [k, v && downcase_keys(v)]}]
+    Hash[(hash || {}).map {|k, v| [k, v && downcase_keys(v)]}]
   end
 end
 
 require File.join(File.dirname(__FILE__), 'ext', 'feature_branch')
+require File.join(File.dirname(__FILE__), 'abstract_feature_branch', 'file_beautifier')

data/lib/abstract_feature_branch/file_beautifier.rb

@@ -0,0 +1,63 @@
+module AbstractFeatureBranch::FileBeautifier
+  def self.process(file_path=nil)
+    if file_path.nil?
+      feature_directory_path = File.join(AbstractFeatureBranch.application_root, 'config', 'features')
+      feature_file_path = File.join(AbstractFeatureBranch.application_root, 'config', 'features.yml')
+      local_feature_file_path = File.join(AbstractFeatureBranch.application_root, 'config', 'features.local.yml')
+      process_directory(feature_directory_path)
+      process_file(feature_file_path)
+      process_file(local_feature_file_path)
+    else
+      if File.directory?(file_path)
+        process_directory(file_path)
+      else
+        process_file(file_path)
+      end
+    end
+    AbstractFeatureBranch.logger.info "File beautification done."
+  end
+
+  def self.process_directory(directory_path)
+    Dir.glob(File.join(directory_path, '**', '*.yml')).each do |file_path|
+      process_file(file_path)
+    end
+  end
+
+  def self.process_file(file_path)
+    AbstractFeatureBranch.logger.info "Beautifying #{file_path}..."
+    file_content = nil
+    File.open(file_path, 'r') do |file|
+      file_content = file.readlines.join
+    end
+    beautified_file_content = beautify(file_content)
+    File.open(file_path, 'w+') do |file|
+      file << beautified_file_content
+    end
+  end
+
+  def self.beautify(content)
+    #Not relying on ordered hashes for backwards compatibility with Ruby 1.8.7
+    sections = []
+    section_features = []
+    content.split("\n").each do |line|
+      if line.strip.empty? || (line.strip.start_with?('#') && !section_features.flatten.empty?)
+        # ignore empty line
+      elsif line.start_with?(" ")
+        section_features.last << line
+      else
+        sections << line
+        section_features << []
+      end
+    end
+    beautified_file_content = ''
+    sections.each_with_index do |section, i|
+      if section.start_with?('#')
+        beautified_file_content << "#{section}\n"
+      else
+        beautified_file_content << "#{section}\n"
+        beautified_file_content << "#{section_features[i].sort.join("\n")}\n\n"
+      end
+    end
+    beautified_file_content
+  end
+end