fastlane-plugin-remove_setting 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bf78e6b0081cefb4d013f51a0cb3298c81ecbea
+  data.tar.gz: 14f782ca6bc6cc2a1cebf102d5d1b45ec9ffa3f8
+SHA512:
+  metadata.gz: 28abdf1acfa6bb12729e265ced41644a1fd76640b9e55a4c8038c3b1cc457b89c4647e3f7176a0e6464b692c7b34a40a207cdcf2ff2db3880b293790b3f63a17
+  data.tar.gz: fc41bff39d27c21979064bbec22c669b46547ec2b2409457d9992a46b7394e2209ae94c27638fae1ff074f3db4d0c6e4cbb4a0c9545e5f292eeaa6fc21c80cd8

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Colin Harris <col.w.harris@gmail.com>
+
+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,121 @@
+# remove_setting plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg?style=flat-square)](https://rubygems.org/gems/fastlane-plugin-remove_setting)
+[![Gem](https://img.shields.io/gem/v/fastlane-plugin-remove_setting.svg?style=flat)](https://rubygems.org/gems/fastlane-plugin-remove_setting)
+[![Downloads](https://img.shields.io/gem/dt/fastlane-plugin-remove_setting.svg?style=flat)](https://rubygems.org/gems/fastlane-plugin-remove_setting)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/col/fastlane-plugin-remove_setting/blob/master/LICENSE)
+[![CircleCI](https://img.shields.io/circleci/project/github/col/remove_setting.svg)](https://circleci.com/gh/col/remove_setting)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-remove_setting`, run the following command:
+```
+fastlane add_plugin remove_setting
+```
+
+## About settings_bundle
+
+Fastlane plugin to remove settings in an iOS settings bundle
+
+### remove_setting
+
+This action removes a specified NSUserDefaults key in the project's
+`Settings.bundle`. 
+
+```ruby
+remove_setting(
+  key: "DevelopmentMode"  
+)
+```
+
+This removes the key named `DevelopmentMode` in the `Root.plist` in the
+`Settings.bundle`.
+
+#### Specifying the project file
+
+By default, the action looks for a single .xcodeproj file in the repo,
+excluding any under Pods. If more than one is present, use the `:xcodeproj`
+parameter:
+
+```ruby
+remove_setting(
+  xcodeproj: "./MyProject.xcodeproj",
+  key: "DevelopmentMode"  
+)
+```
+
+#### Files other than Root.plist
+
+```ruby
+remove_setting(
+  file: "About.plist",
+  key: "DevelopmentMode"  
+)
+```
+
+The `file` argument specifies a file other than `Root.plist` in the
+`Settings.bundle`. If you have multiple projects, keys or files,
+run the action multiple times.
+
+#### Bundle name parameter
+
+By default, this action looks for a file called `Settings.bundle` in the project. To
+specify a different name for your settings bundle, use the `:bundle_name` option:
+```ruby
+remove_setting(
+  key: "DevelopmentMode",
+  bundle_name: "MySettings.bundle"
+)
+```
+
+Also see the [example app](./examples) and [example Fastfile](./fastlane/Fastfile) in the repo.
+
+## Examples
+
+[RemoveSettingExample]: ./examples/RemoveSettingExample
+
+### RemoveSettingExample
+
+See the `examples/RemoveSettingExample` subdirectory for a simple example project that
+makes use of this action.
+
+First build and run the sample project on a simulator or device. Tap 'Open Settings' to view the settings for RemoveSettingExample in the Settings app. You'll see the version number
+as well as a development mode switch.
+
+Now run Fastlane:
+
+```bash
+bundle install
+bundle exec fastlane test
+```
+
+Run the sample app again. Tap 'Open Settings' again to see the updated settings. The development mode switch should no longer be visible.
+
+## Run tests for this plugin
+
+To run both the tests, and 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).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/remove_setting.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/remove_setting/version'
+
+module Fastlane
+  module RemoveSetting
+    # 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::RemoveSetting.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/remove_setting/actions/remove_setting_action.rb

@@ -0,0 +1,126 @@
+# Copyright (c) 2016-17 Colin Harris
+#
+# 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.
+require 'fastlane/plugin/settings_bundle'
+
+module Fastlane
+  module Actions
+    class RemoveSettingAction < Action
+      def self.run(params)
+        key = params[:key]
+        file = params[:file]
+
+        bundleHelper = Fastlane::Helper::SettingsBundleHelper
+        helper = Helper::RemoveSettingHelper
+
+        xcodeproj_path = bundleHelper.xcodeproj_path_from_params params
+        # Error already reported in helper
+        return if xcodeproj_path.nil?
+
+        # try to open project file (raises)
+        project = Xcodeproj::Project.open xcodeproj_path
+
+        # raises
+        helper.remove_setting project, params[:bundle_name], file, key
+      rescue => e
+        UI.user_error! "#{e.message}\n#{e.backtrace}"
+      end
+
+      def self.description
+        'Fastlane plugin action to remove settings in an iOS settings bundle'
+      end
+
+      def self.author
+        'Colin Harris'
+      end
+
+      def self.details
+        "This action is used to automatically delete an entry \n" \
+          "in an app's Settings bundle. It can be used to remove settings \n." \
+          "that you do not want to make available in some environments."
+      end
+
+      def self.available_options
+        [
+          # Required parameters
+          FastlaneCore::ConfigItem.new(key: :key,
+                                       env_name: 'SETTINGS_BUNDLE_KEY',
+                                       description: 'The user defaults key to update in the settings bundle',
+                                       optional: false,
+                                       type: String),
+
+          # Optional parameters
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                       env_name: 'SETTINGS_BUNDLE_XCODEPROJ',
+                                       description: 'An Xcode project file whose settings bundle to update',
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :file,
+                                       env_name: 'SETTINGS_BUNDLE_FILE',
+                                       description: 'The plist file in the Settings.bundle to update',
+                                       optional: true,
+                                       default_value: 'Root.plist',
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :bundle_name,
+                                       env_name: 'SETTINGS_BUNDLE_BUNDLE_NAME',
+                                       description: 'The name of the settings bundle in the project (default Settings.bundle)',
+                                       optional: true,
+                                       default_value: 'Settings.bundle',
+                                       type: String)
+        ]
+      end
+
+      def self.example_code
+        [
+          <<-EOF
+            remove_setting(
+              key: "ItemToRemove"
+            )
+          EOF,
+          <<-EOF
+            remove_setting(
+              xcodeproj: "MyProject.xcodeproj",
+              key: "ItemToRemove",
+            )
+          EOF,
+          <<-EOF
+            remove_setting(
+              file: "About.plist",
+              key: "ItemToRemove"
+            )
+          EOF,
+          <<-EOF
+            remove_setting(
+              key: "ItemToRemove",
+              bundle_name: "MySettings.bundle"
+            )
+          EOF
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.category
+        :project
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/remove_setting/helper/remove_setting_helper.rb

@@ -0,0 +1,70 @@
+# Copyright (c) 2016-17 Colin Harris
+#
+# 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.
+
+require 'plist'
+
+module Fastlane
+  module Helper
+    class RemoveSettingHelper
+      class << self
+        # Takes an open Xcodeproj::Project, extracts the settings bundle
+        # and removes the specified setting key in the specified file.
+        # Raises on error.
+        #
+        # :project: An open Xcodeproj::Project, obtained from Xcodeproj::Project.open, e.g.
+        # :bundle_name: (String) Regex to identify the bundle to look for, usually Settings.bundle.
+        # :file: A settings plist file in the Settings.bundle, usually "Root.plist"
+        # :key: A valid NSUserDefaults key in the Settings.bundle
+        def remove_setting(project, bundle_name, file, key)
+          settings_bundle = project.files.find { |f| f.path =~ /#{bundle_name}/ }
+
+          raise "#{bundle_name} not found in project" if settings_bundle.nil?
+
+          # The #real_path method returns the full resolved path to the Settings.bundle
+          settings_bundle_path = settings_bundle.real_path
+
+          plist_path = File.join settings_bundle_path, file
+
+          # raises IOError
+          settings_plist = File.open(plist_path) { |f| Plist.parse_xml f }
+
+          raise "Could not parse #{plist_path}" if settings_plist.nil?
+
+          preference_specifiers = settings_plist['PreferenceSpecifiers']
+          raise "#{file} is not a settings plist file" if preference_specifiers.nil?
+
+          original_count = preference_specifiers.length
+
+          raise "#{file} is not a settings plist file" if preference_specifiers.nil?
+
+          # Remove the specifier matching the supplied key
+          settings_plist['PreferenceSpecifiers'] = preference_specifiers.reject do |specifier|
+            specifier['Key'] == key
+          end
+
+          raise "preference specifier for key #{key} not found in #{file}" if settings_plist['PreferenceSpecifiers'].length == original_count
+
+          # Save (raises)
+          Plist::Emit.save_plist settings_plist, plist_path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module RemoveSetting
+    VERSION = '0.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-remove_setting
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Colin Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: fastlane-plugin-settings_bundle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.55'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.55'
+description: 
+email: col.w.harris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/remove_setting.rb
+- lib/fastlane/plugin/remove_setting/actions/remove_setting_action.rb
+- lib/fastlane/plugin/remove_setting/helper/remove_setting_helper.rb
+- lib/fastlane/plugin/remove_setting/version.rb
+homepage: https://github.com/col/fastlane-plugin-remove_setting
+licenses:
+- MIT
+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.8
+signing_key: 
+specification_version: 4
+summary: Fastlane plugin to remove settings from an iOS settings bundle
+test_files: []