fakeetc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 565d1540a513a0abc02d642fd11880f9e7e0aec8
-  data.tar.gz: 8c52464577b501000d64c1c60d2d0a5a58af874b
+  metadata.gz: 478ba20702c29d670a5e38f12c8417528c8c04f8
+  data.tar.gz: d8fe0b47e4bccb6208bdb87bbae7f08fdcb28f12
 SHA512:
-  metadata.gz: 9ea9528987f1a7389509d7d8fb898dc8788ea81de51cf1dddd38d22de491dbf0f3c870b46709aaaca460eec086262d10073686f5afbe121baa974dbcc62a7a2b
-  data.tar.gz: 3cc88df0c3dd76b0676aae198d4b70855eee8e343ba3d204407907347a455d8e97bc447caae038e127660eca932a60b20386469772c469a87caf944791888ed3
+  metadata.gz: a2e2517977a497aab29a9a948df92ec1b016f0c0eea4ce97662ec902064c5704840468fd594f57cea4836d1edb5c183467db7a3f815c5a68394d46b386eb680c
+  data.tar.gz: 3515da34591c0e5de8dc75ad5afacac713122b160a5a8d0234993e68889c9bd8704fae1da8e32846e2dd3ca3b309366b77e5f04f70013ee3e4c6a1ef3f7d2716

data/NEWS

@@ -0,0 +1,13 @@
+* fakeetc NEWS
+** 0.2.0 (2015-02-13)
+
+ - Add support for user functions (FakeEtc.getgrgid, FakeEtc.getgrnam, ...)
+ - Add documentation (yardoc)
+
+** 0.1.0 (2015-02-02)
+
+ - First public release
+
+# Local Variables:
+# mode: org
+# End:

data/README.md

@@ -18,13 +18,49 @@ Usage
 require 'fakeetc'
 
 FakeEtc.add_groups({
-  'foo' => { gid: 42, mem: [] },
-  'bar' => { gid: 43, mem: ['johndoe'] }
+  'empty' => { gid: 42, mem: [] },
+  'anonymous' => { gid: 43, mem: ['johndoe'] }
 })
+FakeEtc.add_users({
+  'janedoe' => { uid: 10,
+                 gid: 20,
+                 gecos: 'Jane Doe',
+                 dir: '/home/janedoe',
+                 shell: '/bin/zsh' },
+  'jackdoe' => { uid: 50,
+                 gid: 60,
+                 gecos: 'Jack Doe',
+                 dir: '/home/jackdoe',
+                 shell: '/bin/bash' },
+})
+
+anonymous = nil
+jack = nil
+
 FakeEtc do
-  Etc.getgrnam('bar')
+  anonymous = Etc.getgrnam('anonymous')
+  jack = Etc.getpwuid(50)
 end
-# => #<struct Struct::Group name="bar", passwd="x", gid=43, mem=["johndoe"]>
+
+anonymous
+# => #<struct Struct::Group
+#      name="anonymous",
+#      passwd="x",
+#      gid=43,
+#      mem=["johndoe"]>
+
+jack
+# => #<struct Struct::Passwd
+#      name="jackdoe",
+#      passwd="x",
+#      uid=50,
+#      gid=60,
+#      gecos="Jack Doe",
+#      dir="/home/jackdoe",
+#      shell="/bin/bash",
+#      change=nil,
+#      uclass=nil,
+#      expire=nil>
 ```
 
 Copyright

data/lib/fakeetc/base.rb

@@ -26,13 +26,19 @@
 
 RealEtc = Etc
 
-module FakeEtc
+module FakeEtc # rubocop:disable Documentation
   @groups = {}
+  @users = {}
 
+  # Checks whether FakeEtc is currently activated.
+  # @return [Bool] true if FakeEtc is currently activated, false if it
+  #   is not
   def self.activated?
     @activated
   end
 
+  # Activates FakeEtc.
+  # @return [void]
   def self.activate
     @activated = true
     Object.class_eval do
@@ -41,6 +47,8 @@ module FakeEtc
     end
   end
 
+  # Deactivates FakeEtc.
+  # @return [void]
   def self.deactivate
     Object.class_eval do
       remove_const :Etc
@@ -49,6 +57,8 @@ module FakeEtc
     @activated = false
   end
 
+  # Runs a code block with FakeEtc.
+  # @return [Object] the block's return value
   def self.with
     if activated?
       yield
@@ -62,6 +72,8 @@ module FakeEtc
     end
   end
 
+  # Runs a code block without FakeEtc.
+  # @return [Object] the block's return value
   def self.without
     if !activated?
       yield
@@ -76,7 +88,17 @@ module FakeEtc
   end
 end
 
-def FakeEtc(&block)
+# Runs a code block with FakeEtc.
+#
+# @example
+#   FakeEtc.add_groups('foo' => { gid: 42, mem: %w(bar baz) })
+#   FakeEtc do
+#     Etc.getgrnam('foo').gid
+#   end
+#   # => 42
+#
+# @return [Object] the block's return value
+def FakeEtc(&block) # rubocop:disable Style/MethodName
   return ::FakeEtc unless block
   ::FakeEtc.with(&block)
 end

data/lib/fakeetc/groups.rb

@@ -1,46 +1,83 @@
-module FakeEtc
-  def self.add_groups(group_hash)
-    group_hash.each do |group_name, group_info|
-      group = Struct::Group.new(group_name,
-                                'x',
-                                group_info[:gid],
-                                group_info[:mem])
-      @groups[group_name] = group
+module FakeEtc # rubocop:disable Documentation
+  class << self
+    # Adds groups to the FakeEtc group list.
+    #
+    # @param group_hash [Hash{String=>Hash{Symbol=>Integer,String}}]
+    #   the list of groups that should be added
+    #
+    # @example
+    #   FakeEtc.add_groups({
+    #     'empty' => { gid: 42, mem: [] },
+    #     'anonymous' => { gid: 43, mem: ['johndoe'] }
+    #   })
+    #
+    # @return [void]
+    def add_groups(group_hash)
+      passwd = 'x'
+      group_hash.each do |group_name, group_info|
+        group = Struct::Group.new(group_name,
+                                  passwd,
+                                  group_info[:gid],
+                                  group_info[:mem])
+        @groups[group_name] = group
+      end
     end
-  end
-
-  def self.clear_groups
-    @groups = {}
-  end
 
-  def self.getgrnam(group_name)
-    group = @groups[group_name]
-    fail ArgumentError, "can't find group for #{group_name}" if group.nil?
-    group
-  end
+    # Clears the group list.
+    # @return [void]
+    def clear_groups
+      @groups = {}
+    end
 
-  def self.getgrgid(gid)
-    group = @groups.values.find { |g| g.gid == gid }
-    fail ArgumentError, "can't find group for #{gid}" if group.nil?
-    group
-  end
+    # Finds a group by its group name.
+    # @param group_name [String] the group's name
+    # @return [Struct::Group] the group
+    # @raise [ArgumentError] if no group with the given name can be
+    #   found
+    def getgrnam(group_name)
+      group = @groups[group_name]
+      fail ArgumentError, "can't find group for #{group_name}" if group.nil?
+      group
+    end
 
-  def self.getgrent
-    @group_ents ||= @groups.values
-    @group_ents.shift
-  end
+    # Finds a group by its gid.
+    # @param gid [Integer] the group's gid
+    # @return [Struct::Group] the group
+    # @raise [ArgumentError] if no group with the given gid can be
+    #   found
+    def getgrgid(gid)
+      group = @groups.values.find { |g| g.gid == gid }
+      fail ArgumentError, "can't find group for #{gid}" if group.nil?
+      group
+    end
 
-  def self.endgrent
-    @group_ents = nil
-  end
+    # Returns an entry from the group list. Each successive call
+    # returns the next entry or `nil` if the end of the list has been
+    # reached.
+    #
+    # To reset scanning the group list, use {endgrent}.
+    #
+    # @return [Struct::Group] the next entry in the group list
+    def getgrent
+      @grents ||= @groups.values
+      @grents.shift
+    end
 
-  def self.group
-    return getgrent unless block_given?
+    # Ends the process of scanning through the group list.
+    # @return [void]
+    def endgrent
+      @grents = nil
+    end
+    alias_method :setgrent, :endgrent
 
-    @groups.values.each do |g|
-      yield g
+    # Executes a block for each group entry.
+    # @yield [Struct::Group] the group entry
+    # @return [void]
+    def group
+      return getgrent unless block_given?
+      @groups.values.each { |g| yield g }
+      endgrent
+      nil
     end
-    endgrent
-    nil
   end
 end

data/lib/fakeetc/system.rb

@@ -1,8 +1,10 @@
-module FakeEtc
+module FakeEtc # rubocop:disable Documentation
+  # @return [String] the system's configuration directory
   def self.sysconfdir
     RealEtc.sysconfdir
   end
 
+  # @return [String] the system's temp directory
   def self.systmpdir
     RealEtc.systmpdir
   end

data/lib/fakeetc/users.rb

@@ -1,14 +1,94 @@
-module FakeEtc
+module FakeEtc # rubocop:disable Documentation
   class << self
-    [:endpwent,
-     :getpwent,
-     :getpwnam,
-     :getpwuid,
-     :passwd,
-     :setpwent].each do |m|
-      define_method(m) do
-        fail NotImplementedError, "FakeEtc.#{m} not implemented yet"
+    # Adds users to the FakeEtc user list.
+    #
+    # @param user_hash [Hash{String=>Hash{Symbol=>Integer,String}}]
+    #   the list of users that should be added
+    #
+    # @example
+    #   FakeEtc.add_users({
+    #     'janedoe' => { uid: 10,
+    #                    gid: 20,
+    #                    gecos: 'Jane Doe',
+    #                    dir: '/home/janedoe',
+    #                    shell: '/bin/zsh' },
+    #     'jackdoe' => { uid: 50,
+    #                    gid: 60,
+    #                    gecos: 'Jack Doe',
+    #                    dir: '/home/jackdoe',
+    #                    shell: '/bin/bash' },
+    #   })
+    #
+    # @return [void]
+    def add_users(user_hash)
+      passwd = 'x'
+
+      user_hash.each do |user_name, user_info|
+        user = Struct::Passwd.new(user_name,
+                                  passwd,
+                                  user_info[:uid],
+                                  user_info[:gid],
+                                  user_info[:gecos],
+                                  user_info[:dir],
+                                  user_info[:shell])
+        @users[user_name] = user
       end
     end
+
+    # Clears the user list.
+    # @return [void]
+    def clear_users
+      @users = {}
+    end
+
+    # Finds a user by their user name.
+    # @param user_name [String] the user's name
+    # @return [Struct::Passwd] the user
+    # @raise [ArgumentError] if no user with the given name can be
+    #   found
+    def getpwnam(user_name)
+      user = @users[user_name]
+      fail ArgumentError, "can't find user for #{user_name}" if user.nil?
+      user
+    end
+
+    # Finds a user by their user id.
+    # @param uid [Integer] the user's id
+    # @return [Struct::Passwd] the user
+    # @raise [ArgumentError] if no user with the given id can be found
+    def getpwuid(uid)
+      user = @users.values.find { |u| u.uid == uid }
+      fail ArgumentError, "can't find user for #{uid}" if user.nil?
+      user
+    end
+
+    # Returns an entry from the user list. Each successive call
+    # returns the next entry or `nil` if the end of the list has been
+    # reached.
+    #
+    # To reset scanning the user list, use {endpwent}.
+    #
+    # @return [Struct::Passwd] the next entry in the user list
+    def getpwent
+      @pwents ||= @users.values
+      @pwents.shift
+    end
+
+    # Ends the process of scanning through the user list.
+    # @return [void]
+    def endpwent
+      @pwents = nil
+    end
+    alias_method :setpwent, :endpwent
+
+    # Executes a block for each user entry.
+    # @yield [Struct::Passwd] the user entry
+    # @return [void]
+    def passwd
+      return getpwent unless block_given?
+      @users.values.each { |u| yield u }
+      endpwent
+      nil
+    end
   end
 end

data/lib/fakeetc/version.rb

@@ -1,3 +1,4 @@
-module FakeEtc
-  VERSION = '0.1.0'
+module FakeEtc # rubocop:disable Documentation
+  # Current FakeEtc version.
+  VERSION = '0.2.0'
 end

data/lib/fakeetc.rb

@@ -4,5 +4,7 @@ require 'fakeetc/users'
 require 'fakeetc/system'
 require 'fakeetc/version'
 
+# FakeEtc is a fake Etc module intended as a drop-in replacement for
+# Etc in unit tests.
 module FakeEtc
 end

data/spec/fakeetc_spec.rb

@@ -5,13 +5,28 @@ require 'fakeetc'
 describe FakeEtc do
   before(:each) do
     @groups = {
-      'cheeses' => { gid: 10, mem: ['red_leicester', 'tilsit'] },
-      'parrots' => { gid: 20, mem: ['norwegian_blue', 'macaw'] }
+      'cheeses' => { gid: 10, mem: %w(red_leicester tilsit) },
+      'parrots' => { gid: 20, mem: %w(norwegian_blue macaw) }
+    }
+    @users = {
+      'norwegian_blue' => { uid: 10,
+                            gid: 20,
+                            gecos: 'Remarkable Bird',
+                            dir: '/home/parrot',
+                            shell: '/bin/zsh' },
+      'red_leicester' => { uid: 20,
+                           gid: 10,
+                           gecos: 'a little Red Leicester',
+                           dir: '/home/red_leicester',
+                           shell: '/bin/bash' }
     }
     FakeEtc.add_groups(@groups)
+    FakeEtc.add_users(@users)
   end
 
   after(:each) do
+    FakeEtc.endpwent
+    FakeEtc.clear_users
     FakeEtc.endgrent
     FakeEtc.clear_groups
   end
@@ -137,6 +152,88 @@ describe FakeEtc do
       FakeEtc.systmpdir.must_equal RealEtc.systmpdir
     end
   end
+
+  describe 'getpwnam' do
+    it 'should find users by name' do
+      red_leicester = FakeEtc.getpwnam('red_leicester')
+      red_leicester.must_be_instance_of Struct::Passwd
+      red_leicester.uid.must_equal @users['red_leicester'][:uid]
+      red_leicester.gid.must_equal @users['red_leicester'][:gid]
+      red_leicester.gecos.must_equal @users['red_leicester'][:gecos]
+      red_leicester.dir.must_equal @users['red_leicester'][:dir]
+      red_leicester.shell.must_equal @users['red_leicester'][:shell]
+    end
+
+    it 'should raise exceptions for non-existent users' do
+      user_name = 'not-a-user'
+      err = -> { FakeEtc.getpwnam(user_name) }.must_raise ArgumentError
+      err.message.must_match "can't find user for #{user_name}"
+    end
+  end
+
+  describe 'getpwuid' do
+    it 'should find users by uid' do
+      norwegian_blue = FakeEtc.getpwuid(@users['norwegian_blue'][:uid])
+      norwegian_blue.must_be_instance_of Struct::Passwd
+      norwegian_blue.uid.must_equal @users['norwegian_blue'][:uid]
+      norwegian_blue.gid.must_equal @users['norwegian_blue'][:gid]
+      norwegian_blue.gecos.must_equal @users['norwegian_blue'][:gecos]
+      norwegian_blue.dir.must_equal @users['norwegian_blue'][:dir]
+      norwegian_blue.shell.must_equal @users['norwegian_blue'][:shell]
+    end
+
+    it 'should raise exceptions for non-existent groups' do
+      uid = 247
+      err = -> { FakeEtc.getpwuid(uid) }.must_raise ArgumentError
+      err.message.must_match "can't find user for #{uid}"
+    end
+  end
+
+  describe 'getpwent' do
+    it 'should return all user entries in order' do
+      norwegian_blue = FakeEtc.getpwent
+      red_leicester = FakeEtc.getpwent
+      nil_user = FakeEtc.getpwent
+
+      norwegian_blue.name.must_equal 'norwegian_blue'
+      red_leicester.name.must_equal 'red_leicester'
+      nil_user.must_be_nil
+    end
+  end
+
+  describe 'endpwent' do
+    it 'should reset user traversal' do
+      norwegian_blue_1 = FakeEtc.getpwent
+      FakeEtc.endpwent
+      norwegian_blue_2 = FakeEtc.getpwent
+      norwegian_blue_1.must_equal norwegian_blue_2
+      norwegian_blue_1.name.must_equal 'norwegian_blue'
+    end
+  end
+
+  describe 'passwd' do
+    it 'should execute a given block for each group entry' do
+      users = {}
+      FakeEtc.passwd do |u|
+        users[u.name] = { uid: u.uid,
+                          gid: u.gid,
+                          gecos: u.gecos,
+                          dir: u.dir,
+                          shell: u.shell }
+      end
+      users.must_equal @users
+    end
+
+    it 'should behave like getpwent if there was no block given' do
+      norwegian_blue = FakeEtc.passwd
+      red_leicester = FakeEtc.passwd
+      nil_user = FakeEtc.passwd
+
+      norwegian_blue.name.must_equal 'norwegian_blue'
+      red_leicester.name.must_equal 'red_leicester'
+      nil_user.must_be_nil
+    end
+  end
 end
 
 describe 'FakeEtc' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fakeetc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sebastian Boehm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 5.5.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
 description: |
   FakeEtc is a fake Etc module for your tests.
 email:
@@ -49,6 +63,7 @@ files:
 - Rakefile
 - README.md
 - LICENSE
+- NEWS
 - lib/fakeetc/base.rb
 - lib/fakeetc/groups.rb
 - lib/fakeetc/system.rb
@@ -84,3 +99,4 @@ summary: A fake Etc module for your tests
 test_files:
 - spec/fakeetc_spec.rb
 - spec/spec_helper.rb
+has_rdoc: