tfstats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70b3d2ba865aef7602725a1d6455bcb4d57631c8354c71de7365a54ace5bd7d3
+  data.tar.gz: 653a5d4b7170b20e7eb7ca495fc1effde5c93971b120cee6cc133f0ad64ea786
+SHA512:
+  metadata.gz: 9d17b69b8c47a8c795fc3ec43303c6a8936815b2c64143a95a59fa7f1203bd5cbdafb8d1081a3f3abfe6a6e2fec00c59f283d8bb2b23319593ab84a07c251efc
+  data.tar.gz: 64e81819a34481020ae918c35dbaad0325ef761dc414a95dd24f08af69b258eba25aec78d8ffa802624ab16a35535f878cc567260037e6c3d86369e7847f4394

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.8
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at knut.stenmark@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tfstats.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    tfstats (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  tfstats!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 knut
+
+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,91 @@
+# Tfstats - Terraform Statistics
+
+This gem report code statistics (KLOCs, etc) from the terraform in current or specified directory. It also support recursion from a start point.
+
+Supported:
+
+* `tfstats` - command line
+* `rake stats:terraform` - as a rake task
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tfstats'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tfstats
+
+
+### Installing rake task
+
+In your Rakefile add the following:
+
+```rake
+require 'rake/tfstats_task'
+Rake::TfstatsTask.new do |task|
+  task.directory = "."
+  task.filespec = "*.tf"
+  task.recursive = false
+  task.tabseparated = false
+end
+```
+
+All parameters are optional. The above shows the default:
+
+| Parameter | Description | Example |
+|---|---|---|
+| `directory` | Specify the directory to run from. The directory specified is relative to current directory |  `task.directory = "terraform"` |
+| `filespec` | You can specify a different filespec. |  `task.filespec = "*.{tf,sh,erb,tpl}"` |
+| `recursive` | Set to true to operate recursively on sub-directories. If no files are found in the directory, it will not be listed. |  `task.recursive = true` |
+| `tabseparated` | Output as a tab separated file and not as tabular text |  `task.tabseparated = true` |
+
+## Usage
+
+### Run directly from command line
+
+```bash
+  Usage: tfstats [options] [directory]
+
+  Commands:
+    -r / recursive    : run recursive.
+    -f <filespec>     : specify filespec. Defaults to '*.tf' (use single quote!)
+    -v / verbose      : Output debug information
+    -t / tab          : Tab separated output
+
+  If no directory is specified, statistics is collected from current directory
+```
+
+
+### Run as a rake task
+
+```bash
+  rake stats:terraform
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/stonefield/tfstats. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/stonefield/tfstats/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tfstats project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/stonefield/tfstats/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tfstats"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/tfstats

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+require 'tfstats'
+
+def main
+  #STDERR.puts "Called with: #{ARGV.inspect}"
+  recursive = false
+  filespec = "*.tf"
+  directory = '.'
+  tabseparated = false
+  while arg = ARGV.shift
+    case arg
+    when 'help', '--help', '-h'
+      help
+    when '-r', 'recursive'
+      recursive = true
+    when '-f'
+      filespec = ARGV.shift
+    when '-v', 'verbose'
+      Tfstats.verbose = true
+    when '-t', 'tab'
+      tabseparated = true
+    else
+      directory = arg
+    end
+  end
+
+  Tfstats::Collector.collect(directory, filespec, recursive, tabseparated)
+end
+
+def help
+  puts HELP_TEXT
+  exit 3
+end
+
+HELP_TEXT = <<-DOC
+
+  This program collects terraform statistics.
+  You can also include this in projects with a rake task.
+
+  Usage: #{__FILE__.sub(/.*\//,'')} [options] [directory]
+
+  Commands:
+    -r / recursive    : run recursive.
+    -f <filespec>     : specify filespec. Defaults to '*.tf' (use single quote!)
+    -v / verbose      : Output debug information
+    -t / tab          : Tab separated output
+
+  If no directory is specified, statistics is collected from current directory
+
+DOC
+
+main

data/lib/rake/tfstats_task.rb

@@ -0,0 +1,26 @@
+require 'tfstats'
+
+class Rake::TfstatsTask < Rake::TaskLib
+  attr_accessor :recursive, :filespec, :directory, :tabseparated, :verbose
+
+  def initialize()
+    self.recursive = false
+    self.filespec = "*.tf"
+    self.directory = '.'
+    self.tabseparated = false
+    self.verbose = false
+    yield self if block_given?
+    self.define
+  end
+
+
+  def define
+    namespace :stats do
+      desc 'Display terraform statistics'
+      task :terraform do
+        Tfstats.verbose = self.verbose
+        Tfstats::Collector.collect(directory, filespec, recursive, tabseparated)
+      end
+    end
+  end
+end

data/lib/tfstats/collector.rb

@@ -0,0 +1,127 @@
+#encoding: UTF-8
+Encoding.default_external = Encoding::UTF_8
+require "fileutils"
+module Tfstats
+  class Collector
+    class << self
+      def collect(directory, filespec, recursive, tabseparated)
+        statistics = process_dir(directory, filespec, recursive)
+        puts output( statistics, tabseparated)
+      end
+
+      def process_dir(directory, filespec, recursive)
+        statistics = {}
+        basename = File.basename File.expand_path(directory)
+        info "directory: #{directory}"
+        info "basename: #{basename}"
+        info "filespec: #{filespec}"
+        info "recursive: #{recursive}"
+        if recursive
+          Dir.glob("#{directory}/**/").each do |dir|
+            info "traversing: #{dir}"
+            placeholder = dir.sub(/^#{Regexp.escape(directory.to_s)}/, basename).chop
+            statistics[placeholder] = new(dir, filespec).collect
+          end
+        else
+          statistics[basename] = new(directory,filespec).collect
+        end
+        statistics
+      end
+
+      def output(statistics, tabseparated)
+        str = ''
+        if tabseparated
+          pattern = (["%s"] * 8).join("\t") + + "\n"
+          separator = ''
+        else
+          max_name = statistics.keys.max_by { |s| s.size  }.size
+          pattern = "| %-#{max_name}.#{max_name}s |" + " %9.9s |" * 7 + "\n"
+          separator = '+-'+ ('-' * max_name) + '-+' + ('-' * 11 + '+') * 7 + "\n"
+        end
+        fields = %i(files modules resources data variables lines loc)
+        str << separator
+        str << (pattern % %w(Directory Files modules resources data variables Lines LOC))
+        str << separator
+        statistics.each do |dir, filespecs|
+          t = statistics[dir]
+          unless empty?(t)
+            str << (pattern % ([dir ] + t.values_at(*fields) ))
+          end
+        end
+        str << separator
+        str << (pattern % (["Total"] + sum(statistics).values_at(*fields) ))
+        str << separator
+        str
+      end
+
+      def sum(statistics)
+        s = {}
+        s.default = 0
+        statistics.each do |k, stats|
+          stats.each do |k,v|
+            s[k] += v
+          end
+        end
+        s
+      end
+
+      def empty?(stats)
+        stats.values.sum == 0
+      end
+
+      def info(msg)
+        if Tfstats.verbose
+          puts msg
+        end
+      end
+    end # << self
+
+    attr_accessor :stats, :directory, :filespec
+
+    def initialize(directory, filespec)
+      @directory, @filespec = directory, filespec
+      @stats = {}
+      @stats.default = 0
+    end
+
+    def info(msg)
+      self.class.info msg
+    end
+
+    def collect
+      spec = File.join(directory, filespec)
+      info "Fetching data from: #{spec}"
+      Dir[spec].each do |file|
+        info "Reading file: #{file}"
+        @stats[:files] += 1
+        begin
+          File.read(file).each_line.with_index do |line,i|
+            begin
+              case line
+              when /^\s*#/, /^\s*$/
+              when /^\s*resource/
+                @stats[:resources] += 1
+              when /^\s*module/
+                @stats[:modules] += 1
+              when /^\s*variable/
+                @stats[:variables] += 1
+              when /^\s*data/
+                @stats[:data] += 1
+              else
+                @stats[:loc] += 1
+              end
+            rescue ArgumentError => e
+              STDERR.puts "#{file}:#{i+1} #{e}"
+            end
+            @stats[:lines] += 1
+          end
+        rescue => e
+          STDERR.puts e
+        end
+
+      end
+      @stats
+    end
+
+  end # Collector
+end

data/lib/tfstats/version.rb

@@ -0,0 +1,3 @@
+module Tfstats
+  VERSION = "0.1.0"
+end

data/lib/tfstats.rb

@@ -0,0 +1,15 @@
+require "tfstats/version"
+require "tfstats/collector"
+
+module Tfstats
+  class Error < StandardError; end
+  # Your code goes here...
+  %i(dryrun verbose).each do |key|
+    self.class.define_method(key) do
+      instance_variable_get(:"@#{key}")
+    end
+    self.class.define_method(:"#{key}=") do |value|
+      instance_variable_set(:"@#{key}", value)
+    end
+  end
+end

data/tfstats.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/tfstats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tfstats"
+  spec.version       = Tfstats::VERSION
+  spec.authors       = ["stonefield"]
+  spec.email         = ["knut.stenmark@gmail.com"]
+
+  spec.summary       = %q{Collects statistics for terraform}
+  spec.description   = %q{Supports both comman line and rake task}
+  spec.homepage      = "https://github.com/stonefield/tfstats"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/stonefield/tfstats"
+  spec.metadata["changelog_uri"] = "https://github.com/stonefield/tfstats/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: tfstats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- stonefield
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-02 00:00:00.000000000 Z
+dependencies: []
+description: Supports both comman line and rake task
+email:
+- knut.stenmark@gmail.com
+executables:
+- console
+- setup
+- tfstats
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/tfstats
+- lib/rake/tfstats_task.rb
+- lib/tfstats.rb
+- lib/tfstats/collector.rb
+- lib/tfstats/version.rb
+- tfstats.gemspec
+homepage: https://github.com/stonefield/tfstats
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stonefield/tfstats
+  source_code_uri: https://github.com/stonefield/tfstats
+  changelog_uri: https://github.com/stonefield/tfstats/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Collects statistics for terraform
+test_files: []