structuraid_core 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39b0943343ece08b91c2884a16e133ad77e663c71c8416db4d65248a20871b67
-  data.tar.gz: e9ead6c46af568fd4f7d7fda9cfdd73996f93cff85afdf602161b01caef091f7
+  metadata.gz: 52e1d580435e0d2bf0733e1fad89ee3b9dca50cc06c2b2ab7690506ca07b645c
+  data.tar.gz: aca94e0d33c988f93d3426046ae85b7d5a806334fd5cb96d8d429911cadbb402
 SHA512:
-  metadata.gz: b48678b5b1131cf438cfaf5db1d8c2dac8ba1dc89c2d8ee77f580b7c1386f64c7081fbdd1980c7ea6d8373e93fccb7b414bc4555a1ce4c64461e83e1fd40f780
-  data.tar.gz: d986996199861f01fa6d495bf13b87119d0039d9b23146e545da8e063aab47c8b6ef199a3c232e80a569f0350aec37dcfad856557217830b13a0abdac162ade2
+  metadata.gz: fc35e87f4b023db340e437b4f62a22d5e9fcc892eb0587eda56252775a487bd4e87eb5f4089ef935eee85caf9b02eadfd4d192f1da01c50758331557b77c87c4
+  data.tar.gz: 94d89ced412800fc53fca63ae363dd0475e68b7371979ec6616e7dbbf8b4c98c97abda27882b5b6cba060904feaf425be7d6e9cba862e98a8df990ced372e7b5

data/.rubocop.yml

@@ -7,9 +7,6 @@ AllCops:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-convention:Style/Documentation:
-  Enabled: false
-
 Style/OptionalBooleanParameter:
   Enabled: false
 
@@ -36,3 +33,7 @@ Metrics/ParameterLists:
 
 Style/IfUnlessModifier:
   Enabled: false
+
+Layout/LineLength:
+  AllowedPatterns: ['\A\s*#'] # Ignore rule for comments
+  

data/lib/structuraid_core/elements/footing.rb

@@ -1,5 +1,6 @@
 module StructuraidCore
   module Elements
+    # A footing is a structural element that transfers load from a column to the soil.
     class Footing < Base
       attr_accessor :length_1, :length_2, :height, :material, :cover_lateral, :cover_top, :cover_bottom
       attr_reader :longitudinal_top_reinforcement_length_1,
@@ -10,6 +11,19 @@ module StructuraidCore
 
       VALID_SECTIONS = %i[length_1 length_2].freeze
 
+      # @param length_1 [Float] The length of the footing in the direction of the main section
+      # @param length_2 [Float] The length of the footing in the direction perpendicular to the main section
+      # @param height [Float] The height of the footing
+      # @param material [Materials::Concrete] The material of the footing. It must be concrete
+      # @param cover_lateral [Float] The lateral cover of the footing
+      # @param cover_top [Float] The top cover of the footing
+      # @param cover_bottom [Float] The bottom cover of the footing
+      # @param longitudinal_top_reinforcement_length_1 [Reinforcement::StraightLongitudinal] The longitudinal reinforcement in the direction of the main section
+      # @param longitudinal_bottom_reinforcement_length_1 [Reinforcement::StraightLongitudinal] The longitudinal reinforcement in the direction of the main section
+      # @param longitudinal_top_reinforcement_length_2 [Reinforcement::StraightLongitudinal] The longitudinal reinforcement in the direction perpendicular to the main section
+      # @param longitudinal_bottom_reinforcement_length_2 [Reinforcement::StraightLongitudinal] The longitudinal reinforcement in the direction perpendicular to the main section
+      #
+      # @return [Footing] the footing
       def initialize(
         length_1:,
         length_2:,
@@ -37,10 +51,16 @@ module StructuraidCore
         @main_section = :length_1
       end
 
+      # Computes the horizontal area of the footing
+      # @return [Float] The horizontal area of the footing
       def horizontal_area
-        @length_1 * @length_2
+        length_1 * length_2
       end
 
+      # Computes the effective height of the footing for each direction and for either top or bottom reinforcement
+      # @param section_direction [Symbol] The direction of the section. See VALID_SECTIONS
+      # @param above_middle [Boolean] Whether the reinforcement is above the middle of the footing
+      # @return [Float] The effective height of the footing
       def effective_height(section_direction:, above_middle:)
         case section_direction
         when :length_1
@@ -50,22 +70,33 @@ module StructuraidCore
         end
       end
 
+      # Sets the coordinates system of the footing
+      # @param coordinates_system [Engineering::Locations::CoordinatesSystem] A coordinates system instance
+      # @return [Engineering::Locations::CoordinatesSystem] The coordinates system of the footing
       def add_coordinates_system(coordinates_system)
         @coordinates_system = coordinates_system
       end
 
+      # Adds a column's location to the footing. If the column's location is already in the footing's coordinates system, it returns the existing location.
+      # @param column_location [Engineering::Locations::Absolute] The column's absolute location
+      # @param column_label [String, Symbol] The column's label
+      # @return [Engineering::Locations::Relative] The column's relative location
       def find_or_add_column_location(column_location, column_label)
         label = "column_#{column_label}"
         relative_location_vector = column_location.to_vector - coordinates_system.anchor_location.to_vector
         coordinates_system.find_or_add_location_from_vector(relative_location_vector, label:)
       end
 
+      # Computes the vertices location of the footing's perimeter horizontally and adds them to the footing's coordinates system
       def add_vertices_location
         vertices_locations_vectors.each do |label, vector|
           coordinates_system.find_or_add_location_from_vector(vector, label:)
         end
       end
 
+      # Evaluates if a relative location is inside the footing's perimeter. It works only for horizontal locations (z = 0)
+      # @param location [Engineering::Locations::Relative] The relative location to evaluate
+      # @return [Boolean] Whether the location is inside the footing's perimeter
       def inside_me?(location)
         inside_axis_2 = location.value_2 >= -0.5 * length_2 && location.value_2 <= 0.5 * length_2
         inside_axis_1 = location.value_1 >= -0.5 * length_1 && location.value_1 <= 0.5 * length_1

data/lib/structuraid_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StructuraidCore
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structuraid_core
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Pradaing
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-29 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: puma
+  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: rack
+  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
@@ -94,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: matrix
   requirement: !ruby/object:Gem::Requirement