mdata 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59ba3c43a2d5c4a92d35f80cd17e376009691f59
-  data.tar.gz: 3fd5301f77852b750e80218a71170c42f30db8ba
+  metadata.gz: 7e3bbd437f56887d62ef25076a5b592e38adc217
+  data.tar.gz: fcd07349f0490723c12d3c50f383644d07d40914
 SHA512:
-  metadata.gz: a7f0de6579e18a699d0e08aaff78deadcf7e5ff03cb395e0cca8ea1d2a635832881f4288c902185181d9c2323ff6c58c9a14481afab892d240d5cf587a7a7c10
-  data.tar.gz: f9642aed7d6d97e4f35f58d1dca0b042636a70cfe47434103b009838878e2d2d4eb1e6fae4c49cf3f6f62ef5500e168a316ed8c0c429eb30fd3fda045a388527
+  metadata.gz: 47797064e35bad49dd8b155eeb473c3be459c74cf8ba1f7b2104677c986889f6d0ca8029f7d775f32d68e8beb55f3b982c947114d8be7e3d2023208cfea86326
+  data.tar.gz: d2c9fc0697e1b24ae895493f5116a9a67c9fd9e7ad4430de9c969667caf2698784193e36b7766056c3fcdc542a19562e2fdd0165d879428e7d920c04918dd94a

data/bin/mdata

@@ -5,7 +5,7 @@ require 'commander/import'
 require 'mdata/metadata'
 require 'terminal-table'
 
-program :version, '1.0.0'
+program :version, '1.0.1'
 program :description, 'Your Salesforce metadata navigator and manipulator'
 program :help, 'Author', 'Ben Burwell <ben.burwell@trifecta.com>'
 

data/lib/mdata/metadata/Profile.rb

@@ -4,6 +4,11 @@ require 'mdata/types'
 
 module Salesforce
 	module Metadata
+		# A Salesforce Profile metadata object.
+		#
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm
+		#
+		# @author Ben Burwell
 		class Profile
 		  include ROXML
 
@@ -58,6 +63,15 @@ module Salesforce
 		  	as: [Salesforce::Types::ProfileUserPermission],
 		  	from: 'userPermissions'
 
+		  # Read a profile file from its name and directory
+		  #
+		  # The default file path is `./src/profiles/NAME.profile`, but the
+		  # directory can be overridden by passing a non-nil String.
+		  #
+		  # @param name [String] the name of the profile to read, like 'Admin'
+		  # @param dir [String] the directory to search for the profile in. If
+		  #   nil, defaults to `./src/profiles`.
+		  # @return [Profile] the profile object that has been instantiated
 		  def self.read name, dir
 		  	dir = './src/profiles' if dir.nil?
 		  	filename = "#{dir}/#{name}.profile"
@@ -66,6 +80,9 @@ module Salesforce
 		  	profile
 		  end
 
+		  # Save the profile to disk, writing it to the file from whence it came
+		  # 
+		  # Relies on the profile object having a `@filename` to save to.
 		  def save
 		  	doc = ::Nokogiri::XML::Document.new
 		  	doc.root = to_xml()
@@ -75,6 +92,11 @@ module Salesforce
 		  	end
 		  end
 
+		  # Create an empty profile by name in directory
+		  #
+		  # @param name [String] the name of the profile to create
+		  # @param dir [String] the directory to create it in, defaulting to
+		  #   `./src/profiles`.
 		  def self.touch name, dir
 		  	dir = './src/profiles' if dir.nil?
 		  	filename = "#{dir}/#{name}.profile"

data/lib/mdata/metadata.rb

@@ -1 +1,10 @@
 require 'mdata/metadata/Profile'
+
+module Salesforce
+	# The Metadata module encapsulates the first-class metadata object types in
+	# Salesforce. These are things like Profiles, PermissionSets, Flows, and so
+	# on.
+	#
+	# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_types_list.htm
+	module Metadata; end
+end

data/lib/mdata/types/ApexClassAccess.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic ApexClassAccess class that can be extended for specific
+		# metadata objects, e.g. ProfileApexClassAccess.
+		#
+		# @author Ben Burwell
 		class ApexClassAccess
 			include ROXML
 
@@ -9,6 +13,7 @@ module Salesforce
 			xml_accessor :enabled
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profileApexClassAccess_title
 		class ProfileApexClassAccess < ApexClassAccess; end
 	end
 end

data/lib/mdata/types/ApexPageAccess.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic ApexPageAccess class that can be extended for specific
+		# metadata objects, e.g. ProfileApexPageAccess.
+		#
+		# @author Ben Burwell
 		class ApexPageAccess
 			include ROXML
 
@@ -9,6 +13,7 @@ module Salesforce
 			xml_accessor :enabled
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profileApexPageAccess_title
 		class ProfileApexPageAccess < ApexPageAccess; end
 	end
 end

data/lib/mdata/types/ApplicationVisibility.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic ApplicationVisibility class that can be extended for specific
+		# metadata objects, e.g. ProfileApplicationVisibility.
+		#
+		# @author Ben Burwell
 		class ApplicationVisibility
 			include ROXML
 
@@ -10,6 +14,7 @@ module Salesforce
 			xml_accessor :visible
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profileapplicationvisibility_title
 		class ProfileApplicationVisibility < ApplicationVisibility; end
 	end
 end

data/lib/mdata/types/CustomPermissions.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic CustomPermissions class that can be extended for specific
+		# metadata objects, e.g. ProfileCustomPermissions.
+		#
+		# @author Ben Burwell
 		class CustomPermissions
 			include ROXML
 
@@ -9,6 +13,7 @@ module Salesforce
 			xml_accessor :name
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#ProfileCustomPermissions_title
 		class ProfileCustomPermissions < CustomPermissions; end
 	end
 end

data/lib/mdata/types/ExternalDataSourceAccess.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic ExternalDataSource class that can be extended for specific
+		# metadata objects, e.g. ProfileExternalDataSource.
+		#
+		# @author Ben Burwell
 		class ExternalDataSourceAccess
 			include ROXML
 
@@ -9,6 +13,7 @@ module Salesforce
 			xml_accessor :externalDataSource
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profileExternalDataSourceAccess_title
 		class ProfileExternalDataSourceAccess < ExternalDataSourceAccess; end
 	end
 end

data/lib/mdata/types/FieldLevelSecurity.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic FieldLevelSecurity class that can be extended for specific
+		# metadata objects, e.g. ProfileFieldLevelSecurity.
+		#
+		# @author Ben Burwell
 		class FieldLevelSecurity
 			include ROXML
 
@@ -10,6 +14,11 @@ module Salesforce
 			xml_accessor :hidden
 			xml_accessor :readable
 
+			# Get all the permissions granted as an easy-to-use Array
+			#
+			# @author Ben Burwell
+			# @return [Array] an array of strings representing the permissions that
+			#   are granted.
 			def get_permissions
 				permissions = Array.new
 				permissions.push 'Editable' if @editable == 'true'
@@ -18,10 +27,24 @@ module Salesforce
 				permissions
 			end
 
+			# Get a string representation of the permissions
+			#
+			# @author Ben Burwell
+			# @return [String] the permissions granted on the field, comma separated
 			def to_s
 				get_permissions.join(', ')
 			end
 
+			# Produces a string representation of the permissions suitable for
+			# displaying in a list, à la `ls -la`. The resulting list might look
+			# something like this:
+			#
+			#     Readable Editable
+			#                       Hidden
+			#     Readable
+			# 
+			# @author Ben Burwell
+			# @return [String] the permissions granted on the field, flag-style
 			def to_flag_style
 				flags = ''
 				if @readable == 'true'
@@ -47,6 +70,7 @@ module Salesforce
 
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profilefieldlevelsecurity_title
 		class ProfileFieldLevelSecurity < FieldLevelSecurity; end
 	end
 end

data/lib/mdata/types/LayoutAssignments.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic LayoutAssignments class that can be extended for specific
+		# metadata objects, e.g. ProfileLayoutAssignments.
+		#
+		# @author Ben Burwell
 		class LayoutAssignments
 			include ROXML
 
@@ -9,6 +13,7 @@ module Salesforce
 			xml_accessor :recordType
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profilelayoutassignments
 		class ProfileLayoutAssignments < LayoutAssignments; end
 	end
 end

data/lib/mdata/types/LoginHours.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic LoginHours class that can be extended for specific
+		# metadata objects, e.g. ProfileLoginHours.
+		#
+		# @author Ben Burwell
 		class LoginHours
 			include ROXML
 
@@ -21,6 +25,7 @@ module Salesforce
 			xml_accessor :sundayEnd
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#ProfileLoginHours_title
 		class ProfileLoginHours < LoginHours; end
 	end
 end

data/lib/mdata/types/LoginIpRange.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic LoginIpRange class that can be extended for specific
+		# metadata objects, e.g. ProfileLoginIpRange.
+		#
+		# @author Ben Burwell
 		class LoginIpRange
 			include ROXML
 
@@ -10,6 +14,7 @@ module Salesforce
 			xml_accessor :startAddress
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#ProfileLoginIpRange_title
 		class ProfileLoginIpRange < LoginIpRange; end
 	end
 end

data/lib/mdata/types/ObjectPermissions.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic ObjectPermissions class that can be extended for specific
+		# metadata objects, e.g. ProfileObjectPermissions.
+		#
+		# @author Ben Burwell
 		class ObjectPermissions
 			include ROXML
 
@@ -14,6 +18,7 @@ module Salesforce
 			xml_accessor :viewAllRecords
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profileobjectpermissions_title
 		class ProfileObjectPermissions < ObjectPermissions; end
 	end
 end

data/lib/mdata/types/RecordTypeVisibility.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic RecordTypeVisibility class that can be extended for specific
+		# metadata objects, e.g. ProfileRecordTypeVisibility.
+		#
+		# @author Ben Burwell
 		class RecordTypeVisibility
 			include ROXML
 
@@ -11,6 +15,7 @@ module Salesforce
 			xml_accessor :visible
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profilerecordtypevisibility_title
 		class ProfileRecordTypeVisibility < RecordTypeVisibility; end
 	end
 end

data/lib/mdata/types/TabVisibility.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic TabVisibility class that can be extended for specific
+		# metadata objects, e.g. ProfileTabVisibility.
+		#
+		# @author Ben Burwell
 		class TabVisibility
 			include ROXML
 
@@ -9,6 +13,7 @@ module Salesforce
 			xml_accessor :visibility # enum: DefaultOff, DefaultOn, Hidden
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profiletabvisibility_title
 		class ProfileTabVisibility < TabVisibility; end
 	end
 end

data/lib/mdata/types/UserPermission.rb

@@ -2,6 +2,10 @@ require 'roxml'
 
 module Salesforce
 	module Types
+		# A generic UserPermission class that can be extended for specific
+		# metadata objects, e.g. ProfileUserPermission.
+		#
+		# @author Ben Burwell
 		class UserPermission
 			include ROXML
 
@@ -9,6 +13,7 @@ module Salesforce
 			xml_accessor :name
 		end
 
+		# See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profile.htm#profileUserPerm_title
 		class ProfileUserPermission < UserPermission; end
 	end
 end

data/lib/mdata/types.rb

@@ -11,3 +11,12 @@ require 'mdata/types/ApexPageAccess'
 require 'mdata/types/RecordTypeVisibility'
 require 'mdata/types/TabVisibility'
 require 'mdata/types/UserPermission'
+
+module Salesforce
+	# The `Salesforce::Types` module encapsulates XML node type classes, like
+	# `ApexClassAccess`. These base types are extended for each metadata object
+	# type that needs them, because for some reason ProfileObjectPermissions is
+	# different than PermissionSetObjectPermissions to Salesforce, despite them
+	# having identical structures.
+	module Types; end
+end

data/lib/mdata.rb

@@ -1,2 +1,6 @@
 require 'mdata/types'
 require 'mdata/metadata'
+
+# The Salesforce module encapsulates all classes created in the `mdata` gem.
+# It has two submodules, `Salesforce::Types` and `Salesforce::Metadata`.
+module Salesforce; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdata
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ben Burwell
@@ -103,3 +103,4 @@ signing_key:
 specification_version: 4
 summary: Your Salesforce metadata navigator and manipulator
 test_files: []
+has_rdoc: