ad_licenselint 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3865f9b58fea6e2da9af8009f08e8ad04b979c7c9b2b2974e3fba37aeb589509
+  data.tar.gz: 7f7555f6efbc66a8af23cb5d851c341211669b07a1cc7e5f3846b847f9e9f278
+SHA512:
+  metadata.gz: 90ca6ecf7176ef3bbefc45fe10450916356aeb9d08b1d57fb5e0080026d5ba50fb1f742242ef29b59fde41a890b78a815992d81162f1c7ff8361041757737110
+  data.tar.gz: 76266a5595f2ed1482328a7c2a6c7be940eb48348a904486612e02e230ea7c6e4ed5ae4ec9e4f5cd5998b45fc9a56f82ef3ad8a6b16c6a4f838deeb617fc404e

data/bin/ad_licenselint

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'ad_licenselint'
+puts ADLicenseLint::Runner.new.run

data/lib/ad_licenselint.rb

@@ -0,0 +1,23 @@
+require 'optparse'
+require 'logger'
+require 'colorize'
+require 'tempfile'
+require 'json'
+require 'terminal-table'
+require 'cocoapods-core'
+require 'json'
+
+require 'ad_licenselint/ad_logger'
+require 'ad_licenselint/option_handler'
+require 'ad_licenselint/runner'
+require 'ad_licenselint/license_entry'
+require 'ad_licenselint/constant'
+require 'ad_licenselint/report'
+require 'ad_licenselint/terminal_formatter'
+require 'ad_licenselint/markdown_formatter'
+
+module ADLicenseLint
+  class Error < StandardError; end
+
+  LOGGER = ADLogger.new
+end

data/lib/ad_licenselint/ad_logger.rb

@@ -0,0 +1,33 @@
+module ADLicenseLint
+  class ADLogger
+    SEVERITY = { debug: Logger::DEBUG , info: Logger::INFO, warn: Logger::WARN, error: Logger::ERROR, fatal: Logger::FATAL, unknown: Logger::UNKNOWN }
+    AUTHORIZED_COLORS  = [:black, :yellow, :red, :blue, :green]
+
+    def initialize
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+    end
+
+    def log(level, color, text)
+      exit unless text and level and color
+
+      level, color = [level, color].map(&:to_sym)
+      raise "Color not supported" unless AUTHORIZED_COLORS.include? color
+      raise "Invalid severity" unless SEVERITY.dig(level)
+
+      @logger.add(SEVERITY.dig(level), text.send(color))
+    end
+
+    def debug!
+      @logger.level = Logger::DEBUG
+    end
+
+    def debug?
+      @logger.debug?
+    end
+
+    def close
+      @logger.close
+    end
+  end
+end

data/lib/ad_licenselint/constant.rb

@@ -0,0 +1,8 @@
+module ADLicenseLint
+  module Constant
+    MARKDOWN_FORMAT_OPTION = "md"
+    TERMINAL_FORMAT_OPTION = "term"
+    AVAILABLE_OPTIONS = [MARKDOWN_FORMAT_OPTION, TERMINAL_FORMAT_OPTION]
+    ACCEPTED_LICENSES = ["MIT", "Apache", "BSD"]
+  end
+end

data/lib/ad_licenselint/license_entry.rb

@@ -0,0 +1,31 @@
+class LicenseEntry
+  attr_reader :license_content, :license_name, :pod_name, :source_url
+  attr_writer :source_url
+
+  def initialize(hash)
+    @pod_name = hash["Title"] || ""
+    @license_name = hash["License"] || ""
+    @license_content = hash["FooterText"] || ""
+  end
+
+  def is_valid
+    !pod_name.empty? && !license_name.empty?
+  end
+
+  def is_accepted
+    ADLicenseLint::Constant::ACCEPTED_LICENSES.include?(license_name)
+  end
+
+  def copyright
+    (/Copyright(.*)$/.match license_content)[0]
+  end
+
+  def to_hash
+    {
+      pod_name: @pod_name,
+      license_content: @license_content,
+      license_name: @license_name,
+      source_url: @source_url
+    }
+  end
+end

data/lib/ad_licenselint/markdown_formatter.rb

@@ -0,0 +1,46 @@
+module ADLicenseLint
+  class MarkdownFormatter
+    def initialize(report)
+      @entries = report.entries.sort_by(&:pod_name)
+    end
+
+    def formatted_content
+      "#{table}\n\n#{foldable_content}"
+    end
+
+    private
+
+    def table
+      rows = [
+        "| Pod | License | Source |",
+        "| --- | --- | --- |",
+      ] + @entries.map { |entry|
+        "| #{entry.pod_name} | #{entry.license_name} | #{entry.source_url} |"
+      }
+      rows.join("\n")
+    end
+
+    def foldable_content
+      [
+        "<details>",
+        "<summary>Licenses</summary>",
+        "",
+        licenses_content,
+        "</details>"
+      ].join("\n")
+    end
+
+    def licenses_content
+      @entries
+        .map { |entry|
+          [
+            "### #{entry.pod_name}",
+            "```",
+            entry.license_content,
+            "```",
+          ].join("\n")
+        }
+        .join("\n")
+    end
+  end
+end

data/lib/ad_licenselint/option_handler.rb

@@ -0,0 +1,52 @@
+module ADLicenseLint
+
+  class OptionHandler
+
+    def self.parse
+
+      options = {
+        format: ADLicenseLint::Constant::TERMINAL_FORMAT_OPTION,
+        path: ".",
+        all: false
+      }
+      available_formats = ADLicenseLint::Constant::AVAILABLE_OPTIONS
+
+      parser = OptionParser.new do |p|
+        p.banner = "Usage: ad_licenselint -f [md|term]"
+
+        p.on("-f", "--format [FORMAT]", "[Optional] Select output format [#{available_formats.join(", ")}] (default to #{options[:format]})") do |arg|
+          options[:format] = arg
+        end
+
+        p.on("-p", "--path [PATH]", "[Optional] Sources directory (default to \"#{options[:path]}\")") do |arg|
+          options[:path] = arg
+        end
+
+        p.on("-a", "--all", "[Optional] Display all licenses (default to #{options[:all]})") do |arg|
+          options[:all] = true
+        end
+
+        p.on("-h", "--help", "Prints this help") do
+          puts p
+          exit
+        end
+      end
+
+      begin
+        parser.parse!
+        raise OptionParser::InvalidArgument, "--format" unless available_formats.include?(options[:format])
+      rescue OptionParser::MissingArgument => e
+        LOGGER.log(:error, :red, "Missing argument for option #{e.args.join(",")}")
+        exit
+      rescue OptionParser::InvalidArgument => e
+        LOGGER.log(:error, :red, "Invalid argument for option #{e.args.join(",")}")
+        exit
+      rescue ArgumentError => e
+        LOGGER.log(:error, :red, e.message)
+        raise e
+      end
+
+      options
+    end
+  end
+end

data/lib/ad_licenselint/report.rb

@@ -0,0 +1,17 @@
+module ADLicenseLint
+  class Report
+    attr_reader :entries
+
+    def initialize(entries)
+      @entries = entries
+    end
+
+    def to_hash
+      { entries: @entries.map(&:to_hash) }
+    end
+
+    def empty?
+      @entries.empty?
+    end
+  end
+end

data/lib/ad_licenselint/runner.rb

@@ -0,0 +1,97 @@
+module ADLicenseLint
+
+  class Runner
+    attr_accessor :options, :path
+
+    POD_SOURCE = Pod::Source.new("~/.cocoapods/repos/master")
+
+    def initialize(options = nil)
+      @options = options || OptionHandler.parse
+      @path = File.expand_path(@options[:path])
+    end
+
+    def create_report
+      raise "Folder #{target_support_path} does not exist" if Dir[target_support_path].empty?
+
+      plist_files = Dir[acknowledgements_plist_path] # one plist for each target
+      json_contents = plist_files.map { |plist_file| acknowledgement_json(plist_file) }
+      entries = all_entries(json_contents)
+      warning_entries = entries.reject(&:is_accepted)
+      displayed_entries = options[:all] ? entries : warning_entries
+
+      Report.new(displayed_entries)
+    end
+
+    def run
+      report = create_report
+      return "" if report.empty?
+
+      case options[:format]
+      when ADLicenseLint::Constant::MARKDOWN_FORMAT_OPTION
+        MarkdownFormatter.new(report).formatted_content
+      when ADLicenseLint::Constant::TERMINAL_FORMAT_OPTION
+        TerminalFormatter.new(report).formatted_content
+      end
+    end
+
+    private
+
+    def acknowledgement_json(plist_file)
+      tmp_file = Tempfile.new('license')
+      begin
+        system "plutil -convert json -o #{tmp_file.path} \"#{plist_file}\"" # convert plist to json
+        JSON.parse(File.read(tmp_file.path))
+      ensure
+        tmp_file.close
+        tmp_file.unlink # deletes the temp file
+      end
+    end
+
+    def all_entries(json_contents)
+      pod_names = pod_names_from_podfile
+      entries = json_contents
+        .map { |json| json["PreferenceSpecifiers"].map { |hash| LicenseEntry.new hash } }
+        .flatten
+        .select(&:is_valid)
+        .select { |e| pod_names.include?(e.pod_name) }
+        .uniq(&:pod_name)
+      entries.each { |e| e.source_url = source_url(e.pod_name) }
+      entries
+    end
+
+    def source_url(pod_name)
+      url = git_url(pod_name)
+      url&.gsub(".git", "")
+    end
+
+    def git_url(pod_name)
+      spec = pod_specification(pod_name)
+      spec["source"]["git"] || spec["homepage"] unless spec.nil?
+    end
+
+    def pod_specification(pod_name)
+      set = POD_SOURCE.set(pod_name)
+      return nil if set.highest_version.nil? # access to specification crashes if highest_version is nil
+      set.specification.to_hash
+    end
+
+    def pod_names_from_podfile
+      Pod::Podfile.from_file(podfile_path).dependencies
+        .map(&:name)
+        .map { |e| e.split("/").first } # ex: convert CocoaLumberjack/Swift to CocoaLumberjack
+        .uniq
+    end
+
+    def podfile_path
+      File.join(@path, 'Podfile')
+    end
+
+    def target_support_path
+      File.join(@path, 'Pods', 'Target\ Support\ Files')
+    end
+
+    def acknowledgements_plist_path
+      File.join(target_support_path, "Pods-*/*acknowledgements.plist")
+    end
+  end
+end

data/lib/ad_licenselint/terminal_formatter.rb

@@ -0,0 +1,21 @@
+module ADLicenseLint
+  class TerminalFormatter
+
+    def initialize(report)
+      @report = report
+    end
+
+    def formatted_content
+      rows = @report
+        .entries
+        .sort_by(&:pod_name)
+        .map { |entry|
+          [entry.pod_name, entry.license_name, entry.source_url]
+        }
+      Terminal::Table.new({
+        headings: ['Pod', 'License', 'Source'],
+        rows: rows
+      }).to_s
+    end
+  end
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: ad_licenselint
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pierre Felgines
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: cocoapods-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: Lint the licenses for iOS projects
+email: pierre.felgines@fabernovel.com
+executables:
+- ad_licenselint
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/ad_licenselint
+- lib/ad_licenselint.rb
+- lib/ad_licenselint/ad_logger.rb
+- lib/ad_licenselint/constant.rb
+- lib/ad_licenselint/license_entry.rb
+- lib/ad_licenselint/markdown_formatter.rb
+- lib/ad_licenselint/option_handler.rb
+- lib/ad_licenselint/report.rb
+- lib/ad_licenselint/runner.rb
+- lib/ad_licenselint/terminal_formatter.rb
+homepage: https://rubygems.org/gems/ad_licenselint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Lint the licenses for iOS projects
+test_files: []