fastlane-plugin-acknowledgements 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a96fffce894ebe968c7aeef20b70802cafc44b71
+  data.tar.gz: 0765f8a26162b29ac1ae68baecffb77d961de436
+SHA512:
+  metadata.gz: 8e3c4c4c686ca2a0ca837824fa5b12070b26dac1ba7752c91be27f2d0381783537998ad03000414dff39259ddf312d1c62fc3bb43304558bc1e94b82bc5e68f4
+  data.tar.gz: a19f080ac31cc9b8610bf3c5c8d41cf1545f19ea4624bb819459970f14ad8b9c8d8389f87c11f50d64296ae3a59a3e27074846151928774fb9b4a57315c5009e

data/LICENSE

@@ -0,0 +1,10 @@
+/*
+ * -----------------------------------------------------------------------------------
+ * "THE BEER-WARE LICENSE" (Revision 42):
+ * <http://www.knage.net> & <https://simonrice.com> wrote this file. As long as
+ * you retain this notice you can do whatever you want with this stuff. If we
+ * meet some day, and you think this stuff is worth it, you can buy me a beer
+ * in return.
+ * Christophe Vallinas Knage & Simon Rice.
+ * -----------------------------------------------------------------------------------
+ */

data/README.md

@@ -0,0 +1,75 @@
+# Acknowledgements `fastlane` plugin
+
+[![Fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-acknowledgements)
+![Build Status](https://api.travis-ci.org/simonrice/fastlane-plugin-acknowledgements.svg)
+![](http://ruby-gem-downloads-badge.herokuapp.com/fastlane-plugin-acknowledgements)
+[![Twitter: @_simonrice](https://img.shields.io/badge/contact-@_simonrice-blue.svg?style=flat)](https://twitter.com/_simonrice)
+[![License](https://img.shields.io/badge/license-Beerware_🍺-green.svg?style=flat)](https://github.com/simonrice/fastlane-plugin-acknowledgements/blob/master/LICENSE)
+
+Helping developers give credit where it's rightfully due in an automated fashion!
+
+This plugin builds on the good work done by Christophe Knage on [iOS AcknowledgementGenerator](https://github.com/cvknage/iOS-AcknowledgementGenerator) in the form of a Fastlane plugin, along with adding the ability to strip unwanted markdown from license files.
+
+By the way, Christophe if you're reading this, I owe you a drink should I ever meet you 🍻.
+
+## Getting started
+
+### 1.  Gather your license files
+
+Place all of your licenses from your various dependencies in a directory (e.g., a `licenses` folder in your project directory).  Each license file should be named after your dependency (so an Alamofire license file should be called `Alamofire.license`)
+
+### 2.  Create a settings bundle in your project
+
+You'll see the acknowledgements in your app's settings scene, so create a settings bundle & ensure it is included in your target.
+
+### 3.  Add Plugin
+
+```bash
+fastlane add_plugin acknowledgements
+```
+
+### 4.  Use the plugin in the Fastfile
+
+```ruby
+acknowledgements(
+  settings_bundle: 'path/to/settings.bundle',
+  license_path: 'path/to/licenses'
+)
+```
+
+You can also specify a different extension for your licenses using the optional `license_extension` parameter:
+
+```ruby
+license_extension: '.acknowledgement'
+```
+
+## Run tests for this plugin
+
+To run both the tests & code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+
+## License
+
+Released under the BEER-WARE License 🍺. See the
+[LICENSE](https://github.com/simonrice/fastlane-plugin-acknowledgements/blob/master/LICENSE)
+file for more information.

data/lib/fastlane/plugin/acknowledgements/actions/acknowledgements_action.rb

@@ -0,0 +1,138 @@
+require 'CFPropertyList'
+
+require 'redcarpet'
+require 'redcarpet/render_strip'
+
+module Fastlane
+  module Actions
+    class AcknowledgementsAction < Action
+      ACKNOWLEDGEMENT_GENERATOR_LICENSE = '"THE BEER-WARE LICENSE" (Revision 42):' \
+        '
+        ' \
+        '<http://www.knage.net> & <https://simonrice.com> wrote this file. As long as you retain this notice you ' \
+        'can do whatever you want with this stuff. If we meet some day, and you think ' \
+        'this stuff is worth it, you can buy me a beer in return Christophe Vallinas Knage & Simon Rice.'.freeze
+
+      def self.create_acknowledgement(name, content, settings_bundle)
+        # Create a arbitrary data structure of basic data types
+        acknowledgement = {
+          'StringsTable' => 'ThirdPartyLicenses',
+          'PreferenceSpecifiers' => [{
+            'Type' => 'PSGroupSpecifier',
+            'FooterText' => content
+          }]
+        }
+
+        # Generate name for acknowledgement plist
+        acknowledgement_name = "Acknowledgement-#{name}"
+
+        # Generate item for acknowledgement list
+        acknowledgement_list_item = {
+          'Type' => 'PSChildPaneSpecifier',
+          'Title' => name,
+          'File' => acknowledgement_name
+        }
+
+        # Create plist file
+        plist = CFPropertyList::List.new
+        plist.value = CFPropertyList.guess(acknowledgement)
+        plist.save("#{settings_bundle}/#{acknowledgement_name}.plist", CFPropertyList::List::FORMAT_XML)
+
+        # return
+        acknowledgement_list_item
+      end
+
+      def self.save_acknowledgement_list(acknowledgement_list_items, settings_bundle)
+        # Create a arbitrary data structure of basic data types
+        acknowledgement_list = {
+          'StringsTable' => 'ThirdPartyLicenses',
+          'PreferenceSpecifiers' => acknowledgement_list_items
+        }
+
+        # Create plist file
+        plist = CFPropertyList::List.new
+        plist.value = CFPropertyList.guess(acknowledgement_list)
+        plist.save("#{settings_bundle}/Acknowledgements.plist", CFPropertyList::List::FORMAT_XML)
+      end
+
+      def self.run(params)
+        # UI.message "Parameter API Token: #{params[:api_token]}"
+
+        settings_bundle = params[:settings_bundle]
+        acknowledgement_list = []
+        Dir.glob("#{params[:license_path]}/*#{params[:license_extension]}") do |file|
+          UI.message "Parsing: #{file.split('/').last}..."
+
+          # Extract name
+          license_file_name = File.basename(file)
+          project_name = license_file_name.split('.').first
+
+          # Extract license
+          license_file = File.open(file)
+          project_license = license_file.read
+          parser = Redcarpet::Markdown.new(Redcarpet::Render::StripDown, space_after_headers: true)
+          project_license = parser.render(project_license)
+
+          # Create Acknowledgement- plist
+          acknowledgement_item = create_acknowledgement(project_name, project_license, settings_bundle)
+          license_file.close
+          acknowledgement_list.push(acknowledgement_item)
+        end
+
+        # Push AcknowledgementGenerator License
+        acknowledgement_generator_license = create_acknowledgement('AcknowledgementGenerator (Fastlane Edition)', ACKNOWLEDGEMENT_GENERATOR_LICENSE, settings_bundle)
+        acknowledgement_list.push(acknowledgement_generator_license)
+        sorted_acknowledgements = acknowledgement_list.sort_by { |item| item['Title'].downcase }
+
+        # Create Acknowledgements plist
+        UI.message "Adding acknowledgements to #{settings_bundle}..."
+        save_acknowledgement_list(sorted_acknowledgements, settings_bundle)
+
+        # All finished
+        UI.success 'Acknowledgement Generator Finished'
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Use Fastlane to give credit where it's rightfully due."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :settings_bundle,
+                                       env_name: 'FL_ACKNOWLEDGEMENTS_SETTINGS_BUNDLE',
+                                       description: 'Location of the settings bundle file',
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No Settings Bundle path for AcknowledgementsAction given, pass using `settings_bundle: 'path/to/settings.bundle'`") unless value && !value.empty?
+                                         UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                       end),
+
+          FastlaneCore::ConfigItem.new(key: :license_path,
+                                       env_name: 'FL_ACKNOWLEDGEMENTS_LICENSE_PATH',
+                                       description: 'Path containing the license files',
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No License path for AcknowledgementsAction given, pass using `license_path: 'path/to/licenses/'`") unless value && !value.empty?
+                                         UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                       end),
+
+          FastlaneCore::ConfigItem.new(key: :license_extension,
+                                       env_name: 'FL_ACKNOWLEDGEMENTS_LICENSE_EXTENSION',
+                                       description: "File extension for license files.  Defaults to '.license'.",
+                                       default_value: '.license')
+        ]
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ['@_simonrice', '@cvknage']
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Acknowledgements
+    VERSION = '1.0.0'.freeze
+  end
+end

data/lib/fastlane/plugin/acknowledgements.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/acknowledgements/version'
+
+module Fastlane
+  module Acknowledgements
+    # 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
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Acknowledgements.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-acknowledgements
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Simon Rice
+- Christophe Knage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: CFPropertyList
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.104.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.104.0
+description: 
+email:
+- simon@simonrice.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/acknowledgements.rb
+- lib/fastlane/plugin/acknowledgements/actions/acknowledgements_action.rb
+- lib/fastlane/plugin/acknowledgements/version.rb
+homepage: https://github.com/simonrice/fastlane-plugin-acknowledgements
+licenses:
+- THE BEER-WARE LICENSE
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Use Fastlane to give credit where it's rightfully due
+test_files: []